widdershins
fastify-swagger
widdershins | fastify-swagger | |
---|---|---|
5 | 8 | |
1,458 | 854 | |
1.0% | 2.9% | |
0.0 | 7.7 | |
about 2 months ago | 15 days 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
fastify-swagger
-
Craft OpenAPI Specs & Production-Ready SDKs with Fastify
With Speakeasy, you can create client SDKs based on an OpenAPI specification. Fastify ships with the @fastify/swagger plugin, which provides convenient shortcuts for generating good OpenAPI specifications. We'll start this tutorial by registering @fastify/swagger in a Fastify project to generate a spec.
-
Testing for Breaking Changes in Fastify APIs
First let’s get our current OpenAPI specification out of Fastify and onto the file system. If you have not added the https://github.com/fastify/fastify-swagger plugin first go do that. Then use this simple script I called generate-spec.ts to write your OpenAPI specification to the filesystem.
- Is there a FastAPI alternative for Node?
- Is NestJS good for startups?
-
Automatic swagger ui for nodejs/express? (Info in comments)
The fastify-swagger docs has an example https://github.com/fastify/fastify-swagger
-
Better Backend DX: JSON Schema + TypeScript + Swagger = ✨ Vol. 1
@fastify/swagger is a fastify plugin to serve a Swagger UI, using Swagger (OpenAPI v2) or OpenAPI v3 schemas automatically generated from your route schemas, or from an existing Swagger/OpenAPI schema.
-
How do you write your API documentation? Any self-hosted utilities you'd recommend?
On the Node.js framework side of things, Fastify has support for Swagger with the fastify-swagger plugin.
-
How do you unify TypeScript for both frontend and backend?
With this approach, backend can be any programming languages that support OpenAPI or Swagger. Personally, I use fastify-swagger; but I can also be things like Python's FastAPI or Golang's Gin/Buffalo/Native.
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.
fastify-openapi-glue - A plugin for the Fastify webserver to autogenerate a Fastify configuration based on a OpenApi(v2/v3) specification.
slate - Beautiful static documentation for your API
fastify-jwt - JWT utils for Fastify
swagger-cli - Swagger 2.0 and OpenAPI 3.0 command-line tool
openapi-client-axios - JavaScript client library for consuming OpenAPI-enabled APIs with axios
api2html - A CLI tool to transform Swagger/OpenAPI/AsyncAPI docs to beautiful HTML pages via Shins/Widdershins.
tsoa - Build OpenAPI-compliant REST APIs using TypeScript and Node
openapi-snippet - Generates code snippets for given Swagger / Open API documents
awesome-jsonschema - A curated list of awesome JSON Schema resources, tutorials, tools, and more.
api-template - API documentation template
swagger-jsdoc - Generates swagger/openapi specification based on jsDoc comments and YAML files.