krasi/we_pro_dock
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

140500

Browse Source
This commit is contained in:
krasi
2024-05-14 11:39:33 +03:00
commit 2762ac794a
26 changed files with 1506 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
FRONTEND/OPENAPI.YML.md Normal file
View File

@@ -0,0 +1,14 @@
1. **openapi: 3.0.1**: Это версия спецификации OpenAPI.
2. **info**: Здесь содержится информация о нашем API, такая как название, описание, контактная информация, лицензия и версия API.
3. **tags**: Теги используются для группировки различных эндпоинтов вашего API.
4. **servers**: Здесь указываются серверы, на которых размещено ваше API. В нашем случае, это `http://127.0.0.1:8001/api`.
5. **paths**: Здесь описываются пути к различным ресурсам вашего API, такие как CRUD операции для статей, комментариев, задач и других сущностей.
6. **components**: Здесь определены компоненты вашего API, такие как схемы данных (schemas), ответы (responses), тела запросов (requestBodies), параметры (parameters) и схемы безопасности (securitySchemes). Эти компоненты могут быть использованы в различных запросах и ответах вашего API.
В контексте проекта на Nuxt.js, мы можем использовать эту спецификацию OpenAPI для генерации типов TypeScript для взаимодействия с нашим API. Например, вы можете использовать инструменты, такие как Swagger Codegen, для автоматической генерации клиентских библиотек API на основе этой спецификации, что поможет вам упростить работу с вашим API внутри вашего приложения на Nuxt.js.