widdershins
swagger-cli
widdershins | swagger-cli | |
---|---|---|
5 | 2 | |
1,458 | 513 | |
1.0% | - | |
0.0 | 0.0 | |
about 2 months ago | almost 2 years ago | |
JavaScript | JavaScript | |
MIT License | 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.
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
swagger-cli
-
TypeSpec: A New Language for API-Centric Development
If you are in a situation where you have a backend and you want to expose an API and then you would eventually want a client, you would need format specs as the starting point where server and clients are generated from that one source.
At the moment, OpenAPI with YAML is the only way to go but you can't easily split the spec into separate files as you would do any program with packages, modules and what not.
There are third party tools[0] which are archived and the libraries they depend upon are up for adoption.
In that space, either you can use something like cue language 1] or something like TypeSpec which is purpose built for this so yet, this seems like a great tool although I have not tried it yet myself.
[0]. https://github.com/APIDevTools/swagger-cli
[1]. https://cuelang.org/
EDIT: formating
-
Generating docs from OpenAPI Spec
In order to use Redocusaurus, I needed a single spec file. Both Swagger cli and OpenApi cli offered an option to merge separate specs into one. The problem was that one of them required a "root spec file" to drive the merging and the other required extra information to resolve conflicts. My specs had neither.
What are some alternatives?
swagger2markup - A Swagger to AsciiDoc or Markdown converter to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation.
redocly-cli - ⚒️ Redocly CLI makes OpenAPI easy. Lint/validate to any standard, generate beautiful docs, and more.
fastify-swagger - Swagger documentation generator for Fastify
openapi-generator - OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
slate - Beautiful static documentation for your API
swagger-markdown - swagger to markdown transpiler
api2html - A CLI tool to transform Swagger/OpenAPI/AsyncAPI docs to beautiful HTML pages via Shins/Widdershins.
openapi - An OpenAPI specification for the Stripe API.
openapi-snippet - Generates code snippets for given Swagger / Open API documents
bpmnlint - Validate BPMN diagrams based on configurable lint rules.
api-template - API documentation template
fluent-json-validator - An easy-to-use, expressive, and composable JSON object validator, with a fluent builder pattern interface!