Hey all, I'm looking for an automated solution to ...
# 06-technical-discussiond
Daniel Hsu
05/27/2023, 5:28 PMHey all, I'm looking for an automated solution to taking first pass at (and possibly even maintaining) documentation for an API. Is anyone aware of any generative tools that are good at doing this? Alternately, anyone have any experience using code gen tools to create a project (e.g. langchain-based) that might be able to do something like this? Essentially looking to test out a solution like this with minimal time to test.
If it's helpful, my API is written as an OpenAPI spec.
Daniel Hsu
05/27/2023, 5:29 PMCould be something as simple as an AutoGPT wrapper that'd let me point at a repo and say "document all the YAML files in here"
v
Vishwanath Seshagiri
05/27/2023, 5:48 PMAutodoc is pretty good at codebase documentation!
Vishwanath Seshagiri
05/27/2023, 5:48 PMVishwanath Seshagiri
05/27/2023, 5:50 PMOne caveat: It only explains what is there in the code, and nothing more about intended use. A lot of times codebase documentation also covers usage terms like, how do you use this API etc. That might be missing when using this tool.
d
Diego
05/28/2023, 1:30 AMA very comprehensive solution would be https://github.com/OpenAPITools/openapi-generator
d
Daniel Hsu
06/01/2023, 2:14 AMThanks for the suggestions! Sort of on a similar vein, I'm also curious if anyone's tried automated test writing solutions.