Generate spec from tests

[zoedsoupe]

Why not to generate spec or even schemas from successfully runned tests? It is outside fro this project scope? If not, may I try to contribute implementing it?

[mbuhot]

I've previously used Bureaucrat for tested examples in conjunction with a swagger API spec to generate documentation.

I suppose if your API spec is stored in a JSON file outside of the code, you could record the request/response examples in the tests (like Bureaucrat) and automatically update the schemas in the API spec file after the test run, eg to add new fields to the schemas or new operations to the spec.

Feel free to come up with a proof-of-concept to see if it is feasible and useful :)

[zoedsoupe]

Yeah, I'm researching for some options to generate API documentation and bureaucxrat was the better (almost the only one?). The problem comes when API does not have any swagger spec already created, so you need to create one by hand.

I'll make some tests and come back here to demonstrate!