@svazqz/api-contract-kit 0.1.6-alpha → 0.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,12 +1,30 @@
|
|
|
1
1
|
# api-contract-kit
|
|
2
2
|
|
|
3
|
+
Define your API once, generate OpenAPI docs automatically, and keep server + client perfectly in sync.
|
|
4
|
+
|
|
5
|
+
If this project saves you time, consider giving it a star on GitHub and supporting maintenance with a donation.
|
|
6
|
+
|
|
7
|
+
- Demo project: [api-contract-kit-demo](https://github.com/svazqz/api-contract-kit-demo)
|
|
8
|
+
- Star the project: [github.com/svazqz/api-contract-kit](https://github.com/svazqz/api-contract-kit)
|
|
9
|
+
- Contribute: [ko-fi.com/svazqz](https://ko-fi.com/svazqz)
|
|
10
|
+
|
|
11
|
+
## Why teams adopt it fast
|
|
12
|
+
|
|
13
|
+
- **Automated API docs by default** from the same endpoint contracts used at runtime.
|
|
14
|
+
- **No contract drift** between handlers, consumers, validation, and OpenAPI output.
|
|
15
|
+
- **Framework-agnostic core** with adapters for Next.js, Express, Fastify, Hono, and Nest-style flows.
|
|
16
|
+
- **Type-safe runtime validation** using Zod for params, query, payload, and response.
|
|
17
|
+
- **CI-friendly OpenAPI export** for static docs hosting and artifact publishing.
|
|
18
|
+
|
|
19
|
+
## At a glance
|
|
20
|
+
|
|
3
21
|
`api-contract-kit` is a TypeScript-first library for defining HTTP APIs once and reusing that definition across:
|
|
4
22
|
|
|
5
23
|
- server handlers
|
|
6
24
|
- client consumers
|
|
7
25
|
- OpenAPI generation
|
|
8
26
|
|
|
9
|
-
The
|
|
27
|
+
The core runtime is Fetch-based and framework-agnostic, with adapter layers for multiple server frameworks.
|
|
10
28
|
|
|
11
29
|
## Migration Notice
|
|
12
30
|
|
|
@@ -443,6 +461,7 @@ The library now supports a modular architecture with:
|
|
|
443
461
|
- optional React Query integration
|
|
444
462
|
- OpenAPI automation designed for CI/CD pipelines
|
|
445
463
|
|
|
446
|
-
##
|
|
464
|
+
## Contribute
|
|
447
465
|
|
|
448
|
-
[
|
|
466
|
+
- GitHub Sponsors: [github.com/sponsors/svazqz](https://github.com/sponsors/svazqz)
|
|
467
|
+
- Ko-fi: [ko-fi.com/svazqz](https://ko-fi.com/svazqz)
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@svazqz/api-contract-kit",
|
|
3
3
|
"private": false,
|
|
4
4
|
"description": "A simple way to keep in sync Next api definitions and client types using zod",
|
|
5
|
-
"version": "0.1.
|
|
5
|
+
"version": "0.1.7",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
8
8
|
"url": "git+https://github.com/svazqz/api-contract-kit.git"
|