Embed API Documentation into Docs Site
We are using: https://github.com/swagger-api/swagger-codegen/tree/3.0.0 to create a dynamic website for the Rownd API.
Use https://gitlab.com/rownd/documentation-beta/-/tree/master/Dynamic%20HTML%20for%20API (note, this was created straight from CODEGEN).
Development Considerations:
-
Need CSS added to be in line with Rownd branding -
Need partials to be created so the API can change (and the output of the Swagger CodeGEN can be added to the pipeline) without having to redo the customizations. Just have it match the rest of the site's CSS/Design language. -
Create a new page for the API documentation -
We will be constantly changing the Rownd API, so the partials will be very important. If parts need to be deleted or modified, take notes so we can built that into the pipeline.
If you want to try to create new Code Samples, use the Rownd API.