Adding API documentation #56

New issue

Open

opened 2021-05-01 10:20:55 +02:00 by Jef Roosens · 0 comments

Jef Roosens commented

2021-05-01 10:20:55 +02:00

Owner

The API needs to be documented, e.g. using Swagger.

We can use this repo as inspiration. It uses a YAML file (There's several in this repo, but the idea is the same) to describe the API, according to the OpenAPI 3.0 Spec.

This looks like a good tutorial. We can also look at Swagger, a popular alternative.

The API needs to be documented, e.g. using Swagger. We can use [this repo](https://github.com/firefly-iii/api-docs-generator) as inspiration. It uses a [YAML file](https://github.com/firefly-iii/api-docs-generator/blob/main/yaml/paths/attachments.yaml) (There's several in this repo, but the idea is the same) to describe the API, according to the [OpenAPI 3.0 Spec](https://swagger.io/specification/). [This](https://support.smartbear.com/swaggerhub/docs/tutorials/openapi-3-tutorial.html) looks like a good tutorial. We can also look at [Swagger](https://support.smartbear.com/swaggerhub/docs/tutorials/writing-swagger-definitions.html), a popular alternative.