openapi-preprocessor
ajv
openapi-preprocessor | ajv | |
---|---|---|
2 | 60 | |
34 | 13,402 | |
- | 0.9% | |
3.7 | 6.3 | |
about 1 month ago | 3 days ago | |
Go | TypeScript | |
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.
openapi-preprocessor
-
Show HN: Monocle – bidirectional code generation library
I use a mixed approach for OpenAPI, but not bidirectional.
I have OpenAPI pieces generated from my Go source code (comment, types, function signatures) as JSON.
I also have a manually-edited master YAML document that refers to generated bits via $ref links.
I then use openapi-preprocessor [1] (disclaimer: I wrote it) to produce a final openapi.json file which is committed in the repo.
When I want to extend the API in a spec-first process, I can add the new routes manually in the YAML file. When I do the implementation I replace the manual bits by the generated one when they are ready. When committing I can check the diff of openapi.json to verify I'm not losing in the process.
[1] https://github.com/dolmen-go/openapi-preprocessor
-
JSON Schema bundling finally formalised
Bundling for OpenAPI specification has long been a need for authors to allow to reduce duplication, and to allow to split a big specification in multiples files, but publish a single one.
A few years ago I've written a tool to fit that niche: https://github.com/dolmen-go/openapi-preprocessor
https://github.com/dolmen-go/openapi-preprocessor
I have now to tweak it (well, it will be a major rewrite) to handle $ref relative to $id instead of the file location.
ajv
-
Popular Libraries For Building Type-safe Web Application APIs
Ajv’s documentation is available here.
-
6 Reasons why JSON Schema is worth your time
In the JavaScript ecosystem you can use the excellent AJV package to validate any JavaScript object against a JSON schema. This is especially useful to ensure that API contracts are maintained when communicating with other services.
-
Migrate Your Express Application to Fastify
Since Fastify supports schema validation with Ajv, the validate module is no longer required on the /shorten route, and we can specify the JSON schema directly on the route. The controllers for both routes will largely remain the same, except that the res parameter is renamed to reply as before:
-
Has anybody used Typia library?
There's a ton of schema validators out there and most devs have their personal favorite. Mine was zod and is now typebox + ajv.
-
Accept only specific keys in JSON or form-data format in express?
Good validator library: https://www.npmjs.com/package/ajv
-
Advanced Fastify: Hooks, Middleware, and Decorators
Fastify uses JSON schema to define the validation rules for each route's input payload, which includes the request body, query string, parameters, and headers. The JSON schema is a standard format for defining the structure and constraints of JSON data, and Fastify uses Ajv, one of the fastest and most efficient JSON schema validators available.
-
Getting Started with Fastify for Node.js
In Fastify, JSON schema validation is a built-in feature that allows you to validate the payload of incoming requests before the handler function is executed. This ensures that incoming data is in the expected format and meets the required criteria for your business logic. Fastify's JSON schema validation is powered by the Ajv library, a fast and efficient JSON schema validator.
-
How can we map data from JSON to typescript object efficiently?
I think you're looking for a json schema validator like Ajv or Zod.
-
5 useful JSON tools to improve your productivity
We can use JSON Schema to validate that our data adheres to a specific structure. Ajv is one popular validator tool for JavaScript applications that allows us to create a schema and then validate JSON against that schema. Here's an example of using Ajv to validate one of the above JSON examples against a schema:
-
Ask HN: JSON API object type definitions and validation in 2023?
Hey HN,
We're designing a new system and have been kicking the can about JSON object definitions and validation. Soon we need to settle on a system to validate API request bodies and provide helpful error messages.
In the past, I've used JSON Schema ( https://json-schema.org/ ) to define definitions and ajv ( https://ajv.js.org/ ) to validate, but it's a bit verbose and ajv validation errors are more cryptic than I'd like to deal with.
TypeSchema looks interesting. It seems solid (and perhaps stable?), but development hasn't been active for 2 years. It also looks like we'd still need to generate JSON Schema and choose a validation library
Anyway, I'm very curious how others are approaching this problem. How do you organize and generate validations for your type definitions? What libraries do you use to validate and provide human readable error messages?
Thank you!
What are some alternatives?
oasdiff - OpenAPI Diff and Breaking Changes
joi - The most powerful data validation library for JS [Moved to: https://github.com/hapijs/joi]
zod - TypeScript-first schema validation with static type inference
Yup - Dead simple Object schema validation
api-firewall - Fast and light-weight API proxy firewall for request and response validation by OpenAPI specs.
io-ts - Runtime type system for IO decoding/encoding
tv4 - Tiny Validator for JSON Schema v4
apiclarity - An API security tool to capture and analyze API traffic, test API endpoints, reconstruct Open API specification, and identify API security risks.
class-validator - Decorator-based property validation for classes.
gnostic - A compiler for APIs described by the OpenAPI Specification with plugins for code generation and other API support tasks.
typebox - Json Schema Type Builder with Static Type Resolution for TypeScript