OpenAPI/Swagger API documentation

[fastfrwrd]

We need Swagger and/or OpenAPI documentation for the endpoints in lighthouse-audit-service. it would be preferable to generate these somehow, considering we have TypeScript types annotating the expected requests and responses already.

[Quadrisheriff]

You guys should check out typescript-rest-swagger, sorry i am not a developer so i won't be able to generate the code.

[nikhil-mukunda]

Hi,

I can help you with the documentation. I use a tool called stopstudio to generate excellent OpenAPI documentation. I am looking for projects to take on as well. Let me know.

[Sukkoto]

Hi there. I'd like to help with the docs. I'm new API docs, so it'll be slow going, but I'll work hard on it. Can you help me locate the necessary files/code and existing documentation?

[fastfrwrd]

@freben @Rugvip I wanted to touch base with yall as this is getting a bit of interest - we should think about how we want to provide API documentation for these backends in a consistent manner. Maybe I should close this issue until such a discussion happens, or has one already?

[givonz]

I am interested. Based on the documentation you have, I can generate some API documentation with Spotlight and export the yaml file, which can be imported into Swagger. As for testing, I need some help getting this up & running, which will require a learning curve. I am unfamiliar with docker.