Как документировать API?

Middle
179 просмотров
AFK Offer AI

OpenAPI/Swagger — стандарт для REST. FastAPI генерирует автоматически. Docstrings: описание endpoint в функции. response_model — схема ответа. examples — примеры запросов/ответов. Tags — группировка endpoints. Markdown в описаниях. CHANGELOG — история изменений API. README — quick start, authentication, rate limits. Postman collections — интерактивные примеры. SDK generation: openapi-generator — клиенты на разных языках. Принципы: документация актуальна (генерируется из кода), есть примеры, описаны ошибки, есть getting started guide. Плохая документация = неиспользуемый API.

Следующий вопрос

Что такое orjson?