Здесь собрано все, что нужно для создания и поддержки типового REST API с использованием акутальных инструментов.
Справочники
- Коды HTTP ответов
- Введение в схему Swagger
- Форматы JSON ответов, запросов по стандарту JSON:API
- Форматы JSON ответов, запросов, JSONRPC по гайду от Google
- Описание JWT
Формат ответов
Если нет желания делать по всем-всем-всем стандартами JSON:API, то часто используется гугловый стандарт:
{
"status": "success",
"data": {
/* Application-specific data would go here. */
},
"message": null /* Or optional success message */
}
{
"status": "error",
"data": null, /* or optional error payload */
"message": "Error xyz has occurred"
}
Инструменты для OpenAPI
Исчерпывающий список инструментов тут . Мой выбор:
- Редактор схемы OpenAPI - Swagger Editor
- Шлюз - Kong
- Генерация клиентов по cхеме OpenAPI - Kiota
Специфичные для языков
PHP
- Быстрое добавление API к сущностям на Laravel и Symfony
- Генерация схемы OpenAPI по атрибутам методов и классов
- Валидация запросов по схеме OpenAPI