API documentation

[StolpnerA]

Select and connect API documentation

[StolpnerA]

I suggest https://swagger.io/

We were just on call discussing it.

[zenby]

Could you describe what should be at this API documentation?

[vvscode]

I suppose:

• list of endpoints
• format of request / response
• examples for request / response
• descriptions for all the items

[zenby]

Could you share with your opinion is it reasonable to add it now and add some documentation changes gradually or it's too early for this because we have tasks with higher priority?

[StolpnerA]

@zenby I think documentation need to add with start. This should make it easier for us to work in the future.

[zenby]

I mean we don't have MVP that allows us to see at least one card at anki. At my point of view we should concentrate on it and connected to it tickets.

[vvscode]

we can start from documentation - just design it and we'll implement

@StolpnerA create swagger file and provide PR