Researching solutions for automating and enforcing api documentation updates.
- I want to start by testing out the package here
- I ripped a lot of this example from this repo.
- Here is the blog article that walks you through it.
- An important factor in my decision is the fact that postman has good support for openapi spec now.
- Also, the same can be said about Confluence. Several members of my team and clients in our industry like to consume API docs with Confluence.
- Can I enforce annotations with a linter like eslint?
- Is there a GitHub Actions workflow example that generates docs and publishes updates? Or is it as simple as any deployment to the respective environment?
- How can I scan to make sure annotations exist? Maybe an eslint custom rule.