Skip to content

Commit 0a721d1

Browse files
authored
Added section about REST API
1 parent 51e76e9 commit 0a721d1

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,6 @@ repos:
7373
name: black
7474
entry: black app
7575
language: python
76-
exclude: models
7776
types: [python]
7877

7978
- id: isort
@@ -147,6 +146,13 @@ from some.absolute.path import foo, bar
147146
Код читается намного больше, чем пишется.
148147

149148

149+
## Документация к REST API
150+
Рекомендуемый формат документации - [OpenAPI](https://www.openapis.org).
151+
Схема для OpenAPI должна генерироваться "на лету", чтобы обеспечивать клиентов API свежими изменениями.
152+
153+
**Почему?** Потому что это один из распространенных форматов для документирования REST API, которая вышла из Swagger. Данный формат документации поддерживается большим количеством клиентов (Swagger, Postman, Insomnia Designer и многие другие). Также, рукописная документация имеет свойство быстро устаревать, а документация, которая генерируется напрямую из кода позволяет не думать о постоянных обновлениях документации.
154+
155+
150156
## Pull Request
151157
Дифф PR не должен превышать +/- 1000 строк.
152158

0 commit comments

Comments
 (0)