openapi-preprocessor
runtypes
openapi-preprocessor | runtypes | |
---|---|---|
2 | 22 | |
34 | 2,548 | |
- | 0.3% | |
3.7 | 5.6 | |
about 1 month ago | 3 months 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.
runtypes
-
When should I use runtime checks (and which runtime checker should I use)?
In terms of which runtime checker I should use. The first tutorial I saw suggested 'Zod', doing a bit more searchign yielded other options such as 'runtypes'.
-
An almost religious case for Rust
Runtypes would probably be a better example.
-
'The best thing we can do today to JavaScript is to retire it’ Douglas Crockford
this has been solved by several packages, runtypes https://github.com/pelotom/runtypes being my favorite
-
How to force a type when importing a JSON file?
I personally like https://github.com/pelotom/runtypes because it bundles your Schema Info and the corresponding Typescript types
- Why doesn’t TypeScript natively do any type checking
-
Create d.ts for API response
When I have to deal with data from API calls, I usually use a runtime typing library like Runtypes or Zod to check the responses at the boundary. These libraries can automatically give you TS types (using their static or infer utilities) to use throughout the rest of the project.
-
Typing for JSON Payloads
Also runtypes and (as mentioned below) zod.
-
How to check that an 'unknown' object has a specific key and that the key is a specific type?
Seconding the recommendation to use a library for this. runtypes and io-ts are two other alternatives.
-
Check types at the top level or in each function?
I wouldn't reinvent the wheel: https://github.com/pelotom/runtypes
-
Minimal and fast runtime API payload sanitiser and error message handling
What does your library provide that others don't? For example: https://github.com/colinhacks/zodhttps://github.com/hapijs/joihttps://github.com/jquense/yuphttps://github.com/gcanti/io-tshttps://github.com/pelotom/runtypeshttps://github.com/sindresorhus/ow
What are some alternatives?
oasdiff - OpenAPI Diff and Breaking Changes
zod - TypeScript-first schema validation with static type inference
typescript-is
ajv - The fastest JSON schema Validator. Supports JSON Schema draft-04/06/07/2019-09/2020-12 and JSON Type Definition (RFC8927)
io-ts - Runtime type system for IO decoding/encoding
api-firewall - Fast and light-weight API proxy firewall for request and response validation by OpenAPI specs.
type-fest - A collection of essential TypeScript types
typegraphql-prisma - Prisma generator to emit TypeGraphQL types and CRUD resolvers from your Prisma schema
apiclarity - An API security tool to capture and analyze API traffic, test API endpoints, reconstruct Open API specification, and identify API security risks.
ts-auto-guard - Generate type guard functions from TypeScript interfaces