fastify-swagger
oasdiff
| fastify-swagger | oasdiff | |
|---|---|---|
| 8 | 12 | |
| 854 | 584 | |
| 2.9% | 4.8% | |
| 7.7 | 9.2 | |
| 17 days ago | 4 days ago | |
| JavaScript | Go | |
| MIT License | Apache License 2.0 |
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.
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.
oasdiff
- FLaNK AI for 11 March 2024
-
Serverless APIs: Auto-Generate OpenAPI Docs & CI/CD Protections
We will use an open-source GitHub action, oasdiff-action, based on the tool ‘oasdiff.’
-
How Can You Achieve Continuous Deployment for *APIs*?
Nice, Have you come across this tool oasdiff from the article? It may help with detect API breaking changes in swagger
-
How to prevent breaking API changes with API Gateway
While you might wish that pull request reviewers would spot any breaking changes, relying solely on this method is not certain and might lead to failure eventually. If you have OpenAPI/Swagger documentation for your APIs, these can be version-controlled and included in a CI pipeline. APISIX doesn't natively support direct integration with version control systems like Git for API specification changes. However, you can set up a process outside APISIX. Tools like Oasdiff or Bump can identify changes in API specs, and trigger a CI pipeline (add GitHub Action) that runs tests against the route endpoints in APISIX to ensure no breaking changes are introduced.
- Would you like to be notified when your API provider makes a breaking change?
-
Testing for Breaking Changes in Fastify APIs
Now that we have a way to lookup our API’s behavior with Git, we can start testing for breaking changes between versions of our API. We’ll be using Optic (an open source tool I created) to do just that. If you are looking for other options I recommend https://github.com/OpenAPITools/openapi-diff or https://github.com/Tufin/oasdiff.
-
Ask HN: Non-Breaking API deprecation in OpenAPI spec – what do you think?
2. Delete the API at the sunset date or later
People seem to want such a process in order to prevent breaking-changes.
I wrote a diff tool for OpenAPI spec which supports detection of breaking-changes and I recently extended it to support this process and a bit more.
Now I'm looking for feedback.
Proposed Solution (currently in Beta): https://github.com/Tufin/oasdiff#non-breaking-removal-of-deprecated-resources
Related requests:
- A diff tool and Go module for OpenAPI Specification
- OpenAPI Diff
What are some alternatives?
fastify-openapi-glue - A plugin for the Fastify webserver to autogenerate a Fastify configuration based on a OpenApi(v2/v3) specification.
openapi-preprocessor - An authoring tool for OpenAPI specifications
widdershins - OpenAPI / Swagger, AsyncAPI & Semoasa definitions to (re)Slate compatible markdown
apiclarity - An API security tool to capture and analyze API traffic, test API endpoints, reconstruct Open API specification, and identify API security risks.
fastify-jwt - JWT utils for Fastify
openapi-diff - Utility for comparing two OpenAPI specifications.
openapi-client-axios - JavaScript client library for consuming OpenAPI-enabled APIs with axios
openapi-generator-go - An opinionated OpenAPI v3 code generator for Go. Use this to generate API models and router scaffolding.
tsoa - Build OpenAPI-compliant REST APIs using TypeScript and Node
api-firewall - Fast and light-weight API proxy firewall for request and response validation by OpenAPI specs.
awesome-jsonschema - A curated list of awesome JSON Schema resources, tutorials, tools, and more.
Optic - OpenAPI linting, diffing and testing. Optic helps prevent breaking changes, publish accurate documentation and improve the design of your APIs.