big
big8mo ago

how to document oak api

What’s the best way to document an oak api. Like swagger or some kind of that
2 Replies
Deno AI Helper
Deno AI Helper8mo ago
The documentation does not provide a specific method or tool for documenting an Oak API, such as Swagger or similar tools. However, it's generally a good practice to document your API endpoints, their expected inputs, and outputs, as well as any error messages they might return. This can be done in the code itself through comments, or in a separate documentation file or system. If you're looking for a tool to help with this, Swagger, Postman, and Apiary are all popular choices in the broader web development community, but the documentation does not specify a preferred tool when working with Oak in Deno.
Leokuma
Leokuma8mo ago
I think you will have better answers if you ask for it in the Oak repo