Document API Endpoint¶
Overview¶
Each endpoints should follow this concept:
[1] Document fomat: Markdown
[2] Document layout:
| Type | Value | Required/Optional |
|---|---|---|
| Endpoint | The API endpoint path. E.g: /v1/detail/ | Required |
| HTTP Method | The HTTP method of API endpoint. Enum: GET, HEAD POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH | Required |
| Description | The information of data that endpoint retured | Required |
| Fields Table | Table metadata of fields of outputs | Required |
| Errors | Errors response code with messages | Required |
| Related Documents | Documents that make the endpoints more clear | Optional |
[3] [Optional] Using document-as-code tools to generate markdown documents. E.g: Mermaid