Skip to content

Commit

Permalink
Merge pull request #13 from ka1bi4/Spell_Fix
Browse files Browse the repository at this point in the history
Исправил опечатки
  • Loading branch information
Starkovden authored Oct 19, 2019
2 parents 53e04a7 + 2966a56 commit a6b6048
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Native-library/Javadoc-tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Javadoc ничего не делает с такими комментариям
*/
```

В Eclipse, если ввеcnb `/**` и нажать return, он автоматически заполнит оставшуюся часть синтаксиса.
В Eclipse, если ввести `/**` и нажать return, он автоматически заполнит оставшуюся часть синтаксиса.


Формат для добавления различных элементов выглядит следующим образом:
Expand Down
2 changes: 1 addition & 1 deletion Publishing-doc/API-doc-sites-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
110. [Rundown API](https://rapidapi.com/therundown/api/therundown?endpoint=5ace93eae4b04378c0ca27ba)
111. [Zype API](https://docs.zype.com/reference)

> Ппоследний раз эти ссылки проверялись в марте 2019 года. Учитывая, как все быстро меняется, некоторые ссылки могут быть устаревшими. Однако, если просто набрать {product} + api docs в поиске Google, скорее всего, найдется сайт документации для разработчиков компании. Чаще всего документы по API находятся у разработчика. {Company} .com.
> Последний раз эти ссылки проверялись в марте 2019 года. Учитывая, как все быстро меняется, некоторые ссылки могут быть устаревшими. Однако, если просто набрать {product} + api docs в поиске Google, скорее всего, найдется сайт документации для разработчиков компании. Чаще всего документы по API находятся у разработчика. {Company} .com.
<a name="catalog"></a>
## Programmableweb.com: каталог сайтов документации API в открытой сети
Expand Down
2 changes: 1 addition & 1 deletion Publishing-doc/Hosting-and-deployment-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,6 @@ Netlify CMS дополняет [Netlify CMS](**INSERT LINK**), автономн
> Aerobatic - это специализированная платформа для эффективной доставки статических веб-страниц и ресурсов веб-сайта. Мы позаботимся о деталях конфигурации, которые обеспечат наилучший баланс производительности и удобства обслуживания. Перестаньте возиться с CDN и конфигами веб-сервера и сосредоточьтесь на кодировании отличного интерфейса. - [Static website serving](https://www.aerobatic.com/docs/static-serving/)

В целом, существует множество вариантов размещения и развертывания сайта. GitHub Pages, CloudCannon, Read Docs, Netlify и Aerobatic - это только некоторые из них. Можно изучить кастмоные варианты хостинга и развертывания, доступные через существующую инфраструктуру вашей компании.
В целом, существует множество вариантов размещения и развертывания сайта. GitHub Pages, CloudCannon, Read Docs, Netlify и Aerobatic - это только некоторые из них. Можно изучить кастомные варианты хостинга и развертывания, доступные через существующую инфраструктуру вашей компании.

Есть еще одна категория инструментов для рассмотрения: [автономные CMS (и Readme.io)](Headless-cms-options.md). Автономная CMS часто объединяет решение для разработки и развертывания, поэтому класс инструментов тесно связан с упомянутыми здесь, но все равно она выделена в отдельную категорию на этом курсе.
2 changes: 1 addition & 1 deletion Publishing-doc/Overview-for-publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@

Но угадайте! Какой ведущий разработчик успеет изучить документы? Такой человек обычно глубоко погружен в сложный сценарий программирования. Поэтому тот человек, который обладает знаниями, необходимыми для декомпиляции и вычленения необходимых понятий из документации, обычно не может это сделать. Но если содержание выходит за рамки понимания универсалов, в какой-то момент, писатели должны будут посвятить некоторое время документации. В этих сценариях, говорят Робиллард и Уддин, лучшая помощь будет заключаться в сокращении издержек процесса документирования.

Как редактор/издатель, вы можете помочь такому автору, точно указав причину путаницы, область документа, которая нуждается в обновлении, и предоставив ему простые инструменты для обновления. Разработчики не должны быть обеспокоены поиском генераторов стаитчных сайтов или публикаций рабочих процессов, PDF-файлов или других инструментов публикации документов. Роль редактора/издателя, может внести ценный вклад в работу команды разработчиков продукта. Именно эта роль в качестве специалиста по инструментам документирования особенно актуальна в контексте документации API.
Как редактор/издатель, вы можете помочь такому автору, точно указав причину путаницы, область документа, которая нуждается в обновлении, и предоставив ему простые инструменты для обновления. Разработчики не должны быть обеспокоены поиском генераторов статичных сайтов или публикаций рабочих процессов, PDF-файлов или других инструментов публикации документов. Роль редактора/издателя, может внести ценный вклад в работу команды разработчиков продукта. Именно эта роль в качестве специалиста по инструментам документирования особенно актуальна в контексте документации API.

<a name="colaborate"></a>
## Инструменты совместной работы
Expand Down
2 changes: 1 addition & 1 deletion openAPI-specification/step6-security-object.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ components:
Свойства, которые можно использовать для каждого элемента в объекте `securitySchemes`, включают следующее:

- `type`: протокол авторизации - `apiKey`, `http`, `oath2` или `openIdConnect`.
- `description`: Описание метода безопасности. В Swagger UI это описание появляется в модале авторизации (см. Скриншот ниже). CommonMark Markdown разрешена.
- `description`: Описание метода безопасности. В Swagger UI это описание появляется в модуле авторизации (см. Скриншот ниже). CommonMark Markdown разрешена.
- `name`: Имя значения заголовка, представленного в запросе. Используется только для безопасности типа `apiKey`.
- `in`: Указывает, где применяется ключ безопасности. Варианты: `query`, `header` или `cookie`. Используется только для безопасности типа `apiKey`.
- `scheme`: Используется с авторизацией типа `http`.
Expand Down
4 changes: 2 additions & 2 deletions openAPI-specification/swaggerhub-introduction-and-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@

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

В какой-то момент эксперименты с бесплатным инструментом Swagger UI встречают преграду, и нужно найти другой способ для перехода на следующий уровень. Следующий уровен - это [SwaggerHub](https://swagger.io/tools/swaggerhub/) от [Smartbear](https://smartbear.com/). SwaggerHub предоставляет полное решение для проектирования, управления и публикации документации API способами, которые упрощают жизнь технического писателя API.
В какой-то момент эксперименты с бесплатным инструментом Swagger UI встречают преграду, и нужно найти другой способ для перехода на следующий уровень. Следующий уровень - это [SwaggerHub](https://swagger.io/tools/swaggerhub/) от [Smartbear](https://smartbear.com/). SwaggerHub предоставляет полное решение для проектирования, управления и публикации документации API способами, которые упрощают жизнь технического писателя API.

Более 15 000 команд разработчиков программного обеспечения по всему миру используют SwaggerHub. Поскольку спецификация OpenAPI становится в большей степени отраслевым стандартом для документации API, специфичные инструменты SwaggerHub имеют важное значение.

Expand All @@ -49,7 +49,7 @@

[Smartbear](https://smartbear.com/) - это компания, которая поддерживает и разрабатывает инструменты Swagger с открытым исходным кодом ([Swagger Editor](https://swagger.io/tools/swagger-editor/), [Swagger UI](https://swagger.io/tools/swagger-ui/), [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) и др.). Они также сформировали [инициативу OpenAPI](https://www.openapis.org/), которая ведет эволюцию [спецификации Swagger (OpenAPI)](https://github.com/OAI/OpenAPI-Specification/).

Smartbear разработал SwaggerHub как способ помочь командам совместно работать над спецификацией OpenAPI. Многие из клиентских и серверных SDK могут быть автоматически сгенерированы из SwaggerHub, и существует множество дополнительных функций, которые можyj использовать при разработке, тестировании и публикации своего API.
Smartbear разработал SwaggerHub как способ помочь командам совместно работать над спецификацией OpenAPI. Многие из клиентских и серверных SDK могут быть автоматически сгенерированы из SwaggerHub, и существует множество дополнительных функций, которые могут использовать при разработке, тестировании и публикации своего API.

Для начала работы в SwaggerHub, надо перейти на сайт [swaggerhub.com](https://swagger.io/tools/swaggerhub/), а затем создать учетную запись или войдите в систему, используя свои учетные данные GitHub. После входа вы увидите панель инструментов (Дэшборд) SwaggerHub.

Expand Down

0 comments on commit a6b6048

Please sign in to comment.