3 ms·
The latest version of Swagger Codegen (https://github.com/swagger-api/swagger-codegen https://github.com/swagger-api/swagger-codegen) also automatically generat
by wing328hk 10y ago
The latest version of Swagger Codegen (https://github.com/swagger-api/swagger-codegen https://github.com/swagger-api/swagger-codegen) also automatically generates documentation (markdown) for API clients/libraries, e.g. installation, getting start, doc for API endpoints and models.
Here is an example: https://github.com/wing328/test-java-okhttp https://github.com/wing328/test-java-okhttp
Please pull the latest version and give it a try.
- buremba 10y agoNice! Instead of generating Markdown files, you could also generate full HTML documentation similar to Slate. The generated Markdown files can be used in Slate since the format seems to be similar. Actually I opened an issue in swagger-codegen repo (https://github.com/swagger-api/swagger-codegen/issues/1387 https://github.com/swagger-api/swagger-codegen/issues/1387) and we talked about it. The reason that I created a separate project is that the the example usage section and the format didn't seem to be implemented as language in swagger-codegen.
- wing328hk 10y agoI notice that you put all the clients (C#, Java, Ruby, PHP, etc) under the same Github project. I would suggest you to create separate Github repo for API clients in different languages so that developers can install the PHP, Python, Ruby, etc API clients directly from the Github repo. You can leverage "git_push.sh" to push the auto-generated SDKs (with doc, sample code) to Github.