https://github.com/okunev-e/restapi_examples

Contract API (REST and may be others) examples
https://github.com/okunev-e/restapi_examples

openapi-specification openapi3 rest-api restapi restfull-api swagger

Last synced: 13 days ago
JSON representation

Contract API (REST and may be others) examples

• Host: GitHub
• URL: https://github.com/okunev-e/restapi_examples
• Owner: okunev-e
• License: mit
• Created: 2023-11-30T22:48:41.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-01T12:51:50.000Z (about 1 year ago)
• Last Synced: 2024-11-28T20:49:44.285Z (2 months ago)
• Topics: openapi-specification, openapi3, rest-api, restapi, restfull-api, swagger
• Homepage:
• Size: 64.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Примеры проектирования API

---

#### Содержание

- [Описание REST API с JSON](#restapi_json)

---

В этом разделе хочу показать примеры описания контрактов API, которые приходилось выполнять на разных проектах.

---

### Описание контрактов API, предоставляемых через веб-сервис REST API

Разработка описания выполнялась в Swagger.

Исходный код: [openapi_example.yml](https://github.com/okunev-e/restapi_examples/blob/main/swagger/openapi_example.yml)

Пример прошел успешную валидацию на [swagger.io](https://editor.swagger.io/) и на [yamllint.com](https://www.yamllint.com/).

Посмотреть вживую можно по этой ссылке: [посмотреть пример](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/okunev-e/restapi_examples/main/swagger/openapi_example.yml).