Techwriter Days — Как писать спецификацию API

Марина Виноградова В докладе поделюсь знаниями и практиками оформления документа Спецификация API, созданного на основе OpenAPI версии 3.0.1 и Swagger версии 2.0. Мы познакомимся со структурой документа и полями, обязательными к заполнению минимальной документации. Этот доклад будет полезен как начинающим, так и опытным техническим писатффелям, в работе которых используется в основном подход Docs-as-Сode. Основное внимание уделю полям и практикам их заполнения.

Иконка канала Из жизни Связи
9 подписчиков
12+
1 просмотр
7 дней назад
12+
1 просмотр
7 дней назад

Марина Виноградова В докладе поделюсь знаниями и практиками оформления документа Спецификация API, созданного на основе OpenAPI версии 3.0.1 и Swagger версии 2.0. Мы познакомимся со структурой документа и полями, обязательными к заполнению минимальной документации. Этот доклад будет полезен как начинающим, так и опытным техническим писатффелям, в работе которых используется в основном подход Docs-as-Сode. Основное внимание уделю полям и практикам их заполнения.

, чтобы оставлять комментарии