From 2966a5684611748c8fde4fddbe0b3f08e8ff9483 Mon Sep 17 00:00:00 2001 From: Roman Bug Date: Thu, 17 Oct 2019 20:49:44 +0300 Subject: [PATCH] =?UTF-8?q?=D0=98=D1=81=D0=BF=D1=80=D0=B0=D0=B2=D0=B8?= =?UTF-8?q?=D0=BB=20=D0=BE=D0=BF=D0=B5=D1=87=D0=B0=D1=82=D0=BA=D0=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Native-library/Javadoc-tags.md | 2 +- Publishing-doc/API-doc-sites-list.md | 2 +- Publishing-doc/Hosting-and-deployment-options.md | 2 +- Publishing-doc/Overview-for-publishing.md | 2 +- openAPI-specification/step6-security-object.md | 2 +- openAPI-specification/swagger-ui-tutorial.md | 2 +- openAPI-specification/swaggerhub-introduction-and-tutorial.md | 4 ++-- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Native-library/Javadoc-tags.md b/Native-library/Javadoc-tags.md index 1ed3310..d078674 100644 --- a/Native-library/Javadoc-tags.md +++ b/Native-library/Javadoc-tags.md @@ -64,7 +64,7 @@ Javadoc ничего не делает с такими комментариям */ ``` -В Eclipse, если ввеcnb `/**` и нажать return, он автоматически заполнит оставшуюся часть синтаксиса. +В Eclipse, если ввести `/**` и нажать return, он автоматически заполнит оставшуюся часть синтаксиса. Формат для добавления различных элементов выглядит следующим образом: diff --git a/Publishing-doc/API-doc-sites-list.md b/Publishing-doc/API-doc-sites-list.md index 73f5d90..2bbb330 100644 --- a/Publishing-doc/API-doc-sites-list.md +++ b/Publishing-doc/API-doc-sites-list.md @@ -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. ## Programmableweb.com: каталог сайтов документации API в открытой сети diff --git a/Publishing-doc/Hosting-and-deployment-options.md b/Publishing-doc/Hosting-and-deployment-options.md index 7746a22..3912002 100644 --- a/Publishing-doc/Hosting-and-deployment-options.md +++ b/Publishing-doc/Hosting-and-deployment-options.md @@ -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 часто объединяет решение для разработки и развертывания, поэтому класс инструментов тесно связан с упомянутыми здесь, но все равно она выделена в отдельную категорию на этом курсе. diff --git a/Publishing-doc/Overview-for-publishing.md b/Publishing-doc/Overview-for-publishing.md index 122423c..220e0b8 100644 --- a/Publishing-doc/Overview-for-publishing.md +++ b/Publishing-doc/Overview-for-publishing.md @@ -39,7 +39,7 @@ Но угадайте! Какой ведущий разработчик успеет изучить документы? Такой человек обычно глубоко погружен в сложный сценарий программирования. Поэтому тот человек, который обладает знаниями, необходимыми для декомпиляции и вычленения необходимых понятий из документации, обычно не может это сделать. Но если содержание выходит за рамки понимания универсалов, в какой-то момент, писатели должны будут посвятить некоторое время документации. В этих сценариях, говорят Робиллард и Уддин, лучшая помощь будет заключаться в сокращении издержек процесса документирования. -Как редактор/издатель, вы можете помочь такому автору, точно указав причину путаницы, область документа, которая нуждается в обновлении, и предоставив ему простые инструменты для обновления. Разработчики не должны быть обеспокоены поиском генераторов стаитчных сайтов или публикаций рабочих процессов, PDF-файлов или других инструментов публикации документов. Роль редактора/издателя, может внести ценный вклад в работу команды разработчиков продукта. Именно эта роль в качестве специалиста по инструментам документирования особенно актуальна в контексте документации API. +Как редактор/издатель, вы можете помочь такому автору, точно указав причину путаницы, область документа, которая нуждается в обновлении, и предоставив ему простые инструменты для обновления. Разработчики не должны быть обеспокоены поиском генераторов статичных сайтов или публикаций рабочих процессов, PDF-файлов или других инструментов публикации документов. Роль редактора/издателя, может внести ценный вклад в работу команды разработчиков продукта. Именно эта роль в качестве специалиста по инструментам документирования особенно актуальна в контексте документации API. ## Инструменты совместной работы diff --git a/openAPI-specification/step6-security-object.md b/openAPI-specification/step6-security-object.md index 444b21a..62a6208 100644 --- a/openAPI-specification/step6-security-object.md +++ b/openAPI-specification/step6-security-object.md @@ -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`. diff --git a/openAPI-specification/swagger-ui-tutorial.md b/openAPI-specification/swagger-ui-tutorial.md index 0cc011a..6eea2ec 100644 --- a/openAPI-specification/swagger-ui-tutorial.md +++ b/openAPI-specification/swagger-ui-tutorial.md @@ -148,7 +148,7 @@ Swagger UI - один из самых популярных инструмент Единственная папка, с которой мы будем работать в загруженном zip-архиве, - это папка dist (сокращение от дистрибутива). Все остальное используется, только если мы перекомпилируем файлы Swagger, что выходит за рамки этого руководства. 5. Извлечем папку dist из папки swagger-ui-master в другой каталог. (После этого папку swagger-ui-master и zip-файл можно удалить.) -6. Перетащиим файл спецификации OpenAPI (из шага 1) в папку dist. (Если вы используете предварительно созданные файлы OpenAPI, файл называется либо **openapi_openweathermap.yml**, либо **openapi_sunrise_sunset.yml**.) Ваша файловая структура должна выглядеть следующим образом: +6. Перетащим файл спецификации OpenAPI (из шага 1) в папку dist. (Если вы используете предварительно созданные файлы OpenAPI, файл называется либо **openapi_openweathermap.yml**, либо **openapi_sunrise_sunset.yml**.) Ваша файловая структура должна выглядеть следующим образом: ├── dist │ ├── favicon-16x16.png diff --git a/openAPI-specification/swaggerhub-introduction-and-tutorial.md b/openAPI-specification/swaggerhub-introduction-and-tutorial.md index 3ee205c..a6284c9 100644 --- a/openAPI-specification/swaggerhub-introduction-and-tutorial.md +++ b/openAPI-specification/swaggerhub-introduction-and-tutorial.md @@ -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 имеют важное значение. @@ -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.