swagger2markup
widdershins
| swagger2markup | widdershins | |
|---|---|---|
| 2 | 5 | |
| 2,480 | 1,458 | |
| 0.3% | 1.0% | |
| 1.8 | 0.0 | |
| about 2 years ago | about 2 months ago | |
| Java | JavaScript | |
| Apache License 2.0 | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
swagger2markup
-
API documentation platforms/authoring stacks
I'm already up to my elbows in AsciiDoc/Antora building a new online help platform, and I noticed that Swagger2Markup exists. No idea if it's any good, but I might be able to integrate it into my existing workflow and spit out some usable static content at the other end...
-
They must hate the JS part in JSON
There are ways to generate a pdf from an OpenAPI-definition. You could use something like swagger2markup. But be warned that this approach has a pretty limited flexibility, the tools are often badly supported and it may involve a lot of work.
widdershins
-
Been working on a tutorial to help indies make scalable multiplayer games, looking for feedback before I officially share
You may want to look into other tooling to redesign your Swagger into easier to follow documentation such as: https://github.com/Mermade/widdershins
-
Generating docs from OpenAPI Spec
Widdershins đź‘Ž
-
How to Build a Good API That Won’t Embarrass You
What if you don’t want Swagger, and prefer something simpler? A popular alternative is Slate—a static API you can build and expose on your URL. Something in-between that’s also worth recommending is a combination of widdershins and api2html. It’ll allow you to generate Slate-like docs from Swagger’s definition.
-
Create and deploy API documentation to Kubernetes
First you need to install node.js, npm and Widdershins. To install Widdershins run:
-
Ask HN: Is OpenAPI Documentation Superior?
You can do both. Widdershins converts an OpenAPI definition to the markdown format used by Slatedocs. https://github.com/mermade/Widdershins
What are some alternatives?
openapi-generator - OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
fastify-swagger - Swagger documentation generator for Fastify
kin-openapi - OpenAPI 3.0 (and Swagger v2) implementation for Go (parsing, converting, validation, and more)
slate - Beautiful static documentation for your API
archifacts - archifacts is a library to extract your architectural concepts out of your application's code
swagger-cli - Swagger 2.0 and OpenAPI 3.0 command-line tool
grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API
api2html - A CLI tool to transform Swagger/OpenAPI/AsyncAPI docs to beautiful HTML pages via Shins/Widdershins.
toml.io - Source Code for toml.io
openapi-snippet - Generates code snippets for given Swagger / Open API documents
schedge - API for NYU's course catalog
api-template - API documentation template