OpenAPI дегеніміз не
REST API сипаттауға арналған спецификация
OpenAPI — REST API сипаттауға арналған стандартты спецификация, автоматтандырылған құжаттама мен код генерациясын қамтамасыз етеді.
OpenAPI артықшылықтары
- Бірыңғай API сипаттау стандарты
- Автогенерацияланған құжаттама
- Клиенттік код генерациясы
- Сұраныстар мен жауаптарды тексеру
Негізгі компоненттер
- Info — API метадеректері
- Paths — соңғы нүктелер мен операциялар
- Components — қайта пайдаланылатын схемалар
- Security — аутентификация әдістері
- Servers — базалық URL'дер
Құралдар
- Swagger UI — интерактивті құжаттама
- Swagger Editor — спецификация редакторы
- OpenAPI Generator — код генерациясы
- Redoc — балама құжаттама