Skip to content

Commit

Permalink
Merge pull request #12 from ka1bi4/Spell_Fix
Browse files Browse the repository at this point in the history
Исправил опечатки
  • Loading branch information
Starkovden authored Oct 17, 2019
2 parents 0e07278 + 03f9135 commit 53e04a7
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion conceptual-topics/code-samples.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ REST API позволяет разработчикам использовать
<a name="sampleCode"></a>
## Пример кода для API прогноза погоды

На этом курсе мы рассмотрели [каждый элемент адресной документации](../documenting-api-endpoints/new-endpoint.md) для вымышленной конечной точки, называемой `surfreport`, в API сервиса прогноза погоды, с которым мы работали. Давайте вкратце вернемся к этому сценарию и предположим, что мы также хотим добавить описание кода для отображения отчета о серфинге на веб-странице. Как может выглядеть тако описание? Вот пример:
На этом курсе мы рассмотрели [каждый элемент адресной документации](../documenting-api-endpoints/new-endpoint.md) для вымышленной конечной точки, называемой `surfreport`, в API сервиса прогноза погоды, с которым мы работали. Давайте вкратце вернемся к этому сценарию и предположим, что мы также хотим добавить описание кода для отображения отчета о серфинге на веб-странице. Как может выглядеть такое описание? Вот пример:

Code tutorial for `surfreport` endpoint

Expand Down
2 changes: 1 addition & 1 deletion documenting-api-endpoints/putt-all-together.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ GET surfreport/{beachId}

### Параметры строки запросах

| Параметр строки запроса | Обзательно/ необязательно | Описание | Тип данных |
| Параметр строки запроса | Обязательно/ необязательно | Описание | Тип данных |
|:--|:--|:--|:--|
| days | Optional | Количество дней, включаемых в ответ. По умолчанию = 3 | Integer |
| time | Optional | При указании времени в ответе будет выводиться только указанный час | Integer. Unix format (ms since 1970) UTC |
Expand Down
2 changes: 1 addition & 1 deletion documenting-api-endpoints/step3-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ API могут некорректно обрабатывать параметр,

### Параметры строки запроса

| Параметр строки запроса | Обзательно/ необязательно | Описание | Тип данных |
| Параметр строки запроса | Обязательно/ необязательно | Описание | Тип данных |
|:--|:--|:--|:--|
| days | Optional | Количество дней, включаемых в ответ. По умолчанию = 3 | Integer |
| time | Optional | При указании времени в ответе будет выводиться только указанный час | Integer. Unix format (ms since 1970) UTC |
Expand Down
4 changes: 2 additions & 2 deletions glossary-and-resourses/API-Blueprint-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ form of choices.
}
```

Справочники по синтакису API Blueprint можно посмотреть на ресурсах:
Справочники по синтаксису API Blueprint можно посмотреть на ресурсах:

- [API Blueprint tutorial](https://apiblueprint.org/documentation/tutorial.html)
- [Apiary tutorial](https://help.apiary.io/api_101/api_blueprint_tutorial/)
Expand Down Expand Up @@ -462,7 +462,7 @@ Access current weather data for any location on Earth including over 200,000 cit
+ `sunrise`: `1435610796` (number, optional) - Sunrise time, unix, UTC
+ `sunset`: `1435650870` (number, optional) - Sunset time, unix, UTC
```
> Если сложно копипасить код, файл с кодом можно загрузить из [источника](https://idratherbewriting.com/learnapidoc/assets/files/apiblueprintweatherdata.md).
> Если сложно копипастить код, файл с кодом можно загрузить из [источника](https://idratherbewriting.com/learnapidoc/assets/files/apiblueprintweatherdata.md).
5. Нажимаем `Save`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ $.ajax(settings).done(function (response) {
<a name="explanation"></a>
## Пояснения кода

Пример реализации настолько прост, насколько это возможно в отношении стиля. Но в примерах кода документации API всегда есть желание хранить простые примеры кода. На самом деле, скорее всего, демоверсия вообще не нужна. Просто отображение полезной нагрузки, возвращаемой в браузере, достаточно для разработчика пользовательского интерфейса. Однако для тестирования интересно, чтобы контент действительно отображался на странице.
Пример реализации настолько прост, насколько это возможно в отношении стиля. Но в примерах кода документации API всегда есть желание хранить простые примеры кода. На самом деле, скорее всего, демо-версия вообще не нужна. Просто отображение полезной нагрузки, возвращаемой в браузере, достаточно для разработчика пользовательского интерфейса. Однако для тестирования интересно, чтобы контент действительно отображался на странице.

Вкратце, вот что происходит. Метод `ajax` из jQuery получает полезную нагрузку для URL-адреса конечной точки, а затем назначает его аргументу `data`. При желании мы регистрируем `data` в консоли, чтобы легче было проверить их полезную нагрузку. Чтобы вывести различные свойства объекта, мы используем точечную нотацию. `data.name.text` получает свойство text из объекта `name`, а `data.description.html` получает тело.

Expand Down
2 changes: 1 addition & 1 deletion glossary-and-resourses/RESTAPI-activities.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
<a name="swap"></a>
## Перемены ключа API в примерах кода

Не стоит вставлять ключи API в примеры кода по слеующим причинам:
Не стоит вставлять ключи API в примеры кода по следующим причинам:

- срок действия ключей API истекает;
- ключи API, размещенные в сети, становятся могут использоваться третьими лицами;
Expand Down
2 changes: 1 addition & 1 deletion introduction-rest-apis/what-for-this-course.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

- Во-первых, я чувствовал, что эта информация будет полезна для сообщества технических писателей. Существует очень мало книг или курсов, посвященных стратегиям документации API для технических писателей.
- Во-вторых, было понимание, что благодаря обратной связи можно уточнять информацию и делать ее лучше. Почти ни один контент не попадает в точку в его первом выпуске. Вместо этого контент должен пройти некоторое время через пользовательское тестирование и обратную связь. Подобно тому, как этот итеративный обзор помогает усовершенствовать пользовательскую документацию, тот же принцип применим и к материалам курса. В течение нескольких лет автор проводил десятки презентаций и семинаров по документации API, и каждый раз использовал отзывы для улучшения этого контента.
- Наконец, контент поможет привлечь трафик на [сайт](https://idratherbewriting.com/) . Фактически, посещения страниц курса документации API превосходят посещения блога. Автор размышлял об этом источнике трафика в сообщении в блоге - смотрите, [если пистальство больше не является рыночным навыком, то что является](https://idratherbewriting.com/2018/08/09/writing-no-longer-a-skill/)? Как люди будут находить материал, если не смогут найти его в Интернете? Если бы материал находился только в печатной книге или за брандмауэром, его было бы трудно обнаружить. Контент - это богатый информационный ресурс, который привлекает трафик на любой сайт. Это то, что люди в основном ищут в Интернете.
- Наконец, контент поможет привлечь трафик на [сайт](https://idratherbewriting.com/) . Фактически, посещения страниц курса документации API превосходят посещения блога. Автор размышлял об этом источнике трафика в сообщении в блоге - смотрите, [если писательство больше не является рыночным навыком, то что является](https://idratherbewriting.com/2018/08/09/writing-no-longer-a-skill/)? Как люди будут находить материал, если не смогут найти его в Интернете? Если бы материал находился только в печатной книге или за брандмауэром, его было бы трудно обнаружить. Контент - это богатый информационный ресурс, который привлекает трафик на любой сайт. Это то, что люди в основном ищут в Интернете.

После размещения курса документирования API на сайте в течение нескольких месяцев, отзывы были положительными. Один человек сказал:

Expand Down
2 changes: 1 addition & 1 deletion like-developer/use-methods-with-curl.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

> Многие API требуют публикации запросов, содержащих сообщения JSON в теле. Параметры тела запроса часто зависят от настроек вашего сервиса. Список пар ключ-значение JSON, которые принимает API, называется «Модель» на дисплее интерфейса Swagger.
1. Создаем текстовый файл и пишем в нем следующий код (эта информация будет передана в памраметре `-d` curl запроса):
1. Создаем текстовый файл и пишем в нем следующий код (эта информация будет передана в параметре `-d` curl запроса):

```yaml
{
Expand Down

0 comments on commit 53e04a7

Please sign in to comment.