Automatically Detecting and Documenting API Endpoints with Akita

akitasoftware.com

6 pointsjeanyang2 comments

Open articleView on HN

So, instead of documenting APIs at the design/development stage, we'll do it at runtime (after product ships)?

I can see a number of issues:

- parameters that were never used during the capture window

- parameters' range, special values

- mandatory or optional parameters

It appears this tool is solving the wrong problem.

Hi @java-man, I'm on the team building the tool. You can run this tool in the development stage to pick up anything you missed at the design stage! You can also run it in production, but you don't have to. We also have inference algorithms to detect parameter ranges, special parameters, and surface which parameters may be optional.

Reply on news.ycombinator.com