Skip to main content
✱ Описание API/SDK, Docs as Code

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

Techwriter Days #1
2024-04-05 17:35
Секция B
40 мин
Средне
Доклад был на прошедшей конференции Techwriter Days #1 и сейчас находится в архиве.
В докладе поделюсь знаниями и практиками оформления документа Спецификация API, созданного на основе OpenAPI версии 3.0.1 и Swagger версии 2.0. Мы познакомимся со структурой документа и полями, обязательными к заполнению минимальной документации. Этот доклад будет полезен как начинающим, так и опытным техническим писателям, в работе которых используется в основном подход Docs-as-Сode. Основное внимание уделю полям и практикам их заполнения.

Доступно только после покупки 😊

Доступно только после покупки 😊

Другие доклады Techwriter Days #1