fork of hey-api/openapi-ts because I need some additional things
Merge pull request #1712 from hey-api/docs/collaborators
docs: add Jacob to Fastify plugin collaborators
+151
-9
+21
docs/.vitepress/theme/components/AuthorsList.vue
+21
docs/.vitepress/theme/components/AuthorsList.vue
···
1
+
<script setup lang="ts">
2
+
type Person = {
3
+
github: string;
4
+
name: string;
5
+
};
6
+
7
+
defineProps<{
8
+
people: Person[];
9
+
}>();
10
+
</script>
11
+
12
+
<template>
13
+
<ul class="authors-list">
14
+
<li v-for="person in people" :key="person.github">
15
+
<a :href="person.github" rel="noopener noreferrer" target="_blank">
16
+
<img :alt="person.name" :src="`${person.github}.png`" />
17
+
<h3>{{ person.name }}</h3>
18
+
</a>
19
+
</li>
20
+
</ul>
21
+
</template>
+49
docs/.vitepress/theme/custom.css
+49
docs/.vitepress/theme/custom.css
···
48
48
margin: 0;
49
49
}
50
50
51
+
.authors-list {
52
+
display: flex;
53
+
flex-wrap: wrap;
54
+
font-size: 1rem;
55
+
gap: 1em;
56
+
padding: 0 !important;
57
+
}
58
+
59
+
.authors-list img {
60
+
border-radius: 50%;
61
+
display: block;
62
+
height: 2rem;
63
+
width: 2rem;
64
+
}
65
+
66
+
.authors-list a {
67
+
align-items: center;
68
+
border: 1px solid transparent;
69
+
border-radius: 10px;
70
+
display: flex;
71
+
column-gap: 0.4em;
72
+
padding: 0.4em 0.6em;
73
+
text-decoration: none;
74
+
transition: border-color ease-out 300ms;
75
+
}
76
+
77
+
.authors-list h3 {
78
+
color: var(--vp-c-text-1);
79
+
font-size: inherit;
80
+
margin: 0;
81
+
}
82
+
83
+
.authors-list a::after {
84
+
display: none !important;
85
+
}
86
+
87
+
.authors-list li {
88
+
margin: 0 !important;
89
+
}
90
+
91
+
h3#demo + iframe,
92
+
h3#demo + button {
93
+
margin: 1rem 0 0;
94
+
}
95
+
51
96
.buttonLink {
52
97
color: var(--vp-c-brand-1);
53
98
font-size: 16px;
···
67
112
text-align: center;
68
113
}
69
114
115
+
.authors-list li,
70
116
.home-list li,
71
117
.sponsors-list li {
72
118
list-style: none;
···
129
175
width: 100%;
130
176
}
131
177
178
+
html.dark .authors-list li > a,
132
179
html.dark .sponsors-list li > a {
133
180
background-color: var(--vp-button-brand-bg);
134
181
}
···
138
185
display: none;
139
186
}
140
187
188
+
.authors-list li > a:hover,
189
+
.authors-list li > a:focus,
141
190
.sponsors-list li > a:hover,
142
191
.sponsors-list li > a:focus {
143
192
border-color: var(--vp-c-brand-1);
+4
docs/.vitepress/theme/index.ts
+4
docs/.vitepress/theme/index.ts
···
5
5
// custom CSS must be imported after default theme to correctly apply styles
6
6
import './custom.css';
7
7
8
+
import AuthorsList from './components/AuthorsList.vue';
8
9
import Layout from './Layout.vue';
9
10
10
11
export default {
11
12
Layout,
13
+
enhanceApp: ({ app }) => {
14
+
app.component('AuthorsList', AuthorsList);
15
+
},
12
16
extends: DefaultTheme,
13
17
} satisfies Theme;
+5
-1
docs/openapi-ts/clients/axios.md
+5
-1
docs/openapi-ts/clients/axios.md
···
13
13
Axios client is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
14
14
:::
15
15
16
+
### About
17
+
16
18
[Axios](https://axios-http.com/) is a simple promise based HTTP client for the browser and Node.js. Axios provides a simple to use library in a small package with a very extensible interface.
17
19
20
+
### Demo
21
+
18
22
<button class="buttonLink" @click="(event) => embedProject('hey-api-client-axios-example')(event)">
19
-
Live demo
23
+
Launch demo
20
24
</button>
21
25
22
26
## Installation
+5
-1
docs/openapi-ts/clients/fetch.md
+5
-1
docs/openapi-ts/clients/fetch.md
···
13
13
Fetch API client is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
14
14
:::
15
15
16
+
### About
17
+
16
18
The [Fetch API](https://developer.mozilla.org/docs/Web/API/Fetch_API) provides an interface for fetching resources (including across the network). It is a more powerful and flexible replacement for XMLHttpRequest.
17
19
20
+
### Demo
21
+
18
22
<button class="buttonLink" @click="(event) => embedProject('hey-api-client-fetch-example')(event)">
19
-
Live demo
23
+
Launch demo
20
24
</button>
21
25
22
26
## Installation
+3
-1
docs/openapi-ts/clients/next-js.md
+3
-1
docs/openapi-ts/clients/next-js.md
···
9
9
Next.js client is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Next.js](https://nextjs.org/) is the React framework for the web. Used by some of the world's largest companies, Next.js enables you to create high-quality web applications with the power of React components.
13
15
14
16
<!-- <button class="buttonLink" @click="(event) => embedProject('hey-api-client-next-example')(event)">
15
-
Live demo
17
+
Launch demo
16
18
</button> -->
17
19
18
20
## Installation
+3
-1
docs/openapi-ts/clients/nuxt.md
+3
-1
docs/openapi-ts/clients/nuxt.md
···
9
9
Nuxt client is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Nuxt](https://nuxt.com/) is an open source framework that makes web development intuitive and powerful.
13
15
14
16
<!-- <button class="buttonLink" @click="(event) => embedProject('hey-api-client-fetch-example')(event)">
15
-
Live demo
17
+
Launch demo
16
18
</button> -->
17
19
18
20
## Installation
+3
-1
docs/openapi-ts/get-started.md
+3
-1
docs/openapi-ts/get-started.md
···
15
15
16
16
[@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) is an OpenAPI to TypeScript codegen trusted more than 800k times each month to generate reliable API clients and SDKs. The code is [MIT-licensed](/license) and free to use. Discover available features below or view our [roadmap](https://github.com/orgs/hey-api/discussions/1495) to learn what's coming next.
17
17
18
+
### Demo
19
+
18
20
<button class="buttonLink" @click="(event) => embedProject('hey-api-example')(event)">
19
-
Live demo
21
+
Launch demo
20
22
</button>
21
23
22
24
## Features
+2
docs/openapi-ts/plugins/ajv.md
+2
docs/openapi-ts/plugins/ajv.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1476).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Ajv](https://ajv.js.org/) is the fastest JSON validator for Node.js and browser.
13
15
14
16
<!--@include: ../../sponsors.md-->
+2
docs/openapi-ts/plugins/arktype.md
+2
docs/openapi-ts/plugins/arktype.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1473).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Arktype](https://arktype.io/) is a TypeScript's 1:1 validator, optimized from editor to runtime.
13
15
14
16
<!--@include: ../../sponsors.md-->
+2
docs/openapi-ts/plugins/express.md
+2
docs/openapi-ts/plugins/express.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1484).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Express](https://expressjs.com/) is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.
13
15
14
16
<!--@include: ../../sponsors.md-->
+2
docs/openapi-ts/plugins/faker.md
+2
docs/openapi-ts/plugins/faker.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1485).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Faker](https://fakerjs.dev/) is a popular library that generates fake (but reasonable) data that can be used for things such as unit testing, performance testing, building demos, and working without a completed backend.
13
15
14
16
<!--@include: ../../sponsors.md-->
+12
-2
docs/openapi-ts/plugins/fastify.md
+12
-2
docs/openapi-ts/plugins/fastify.md
···
9
9
Fastify plugin is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Fastify](https://fastify.dev/) is a fast and low overhead web framework for Node.js.
15
+
16
+
<!-- ### Demo
13
17
14
18
<button class="buttonLink" @click="(event) => embedProject('hey-api-client-fetch-plugin-fastify-example')(event)">
15
-
Live demo
16
-
</button>
19
+
StackBlitz
20
+
</button> -->
21
+
22
+
### Collaborators
23
+
24
+
<AuthorsList :people="[
25
+
{ name: 'Jacob Cohen', github: 'https://github.com/jacobinu' },
26
+
]" />
17
27
18
28
## Features
19
29
+2
docs/openapi-ts/plugins/hono.md
+2
docs/openapi-ts/plugins/hono.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1483).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Hono](https://hono.dev/) is a small, simple, and ultrafast web framework built on Web Standards. It works on any JavaScript runtime: Cloudflare Workers, Fastly Compute, Deno, Bun, Vercel, Netlify, AWS Lambda, Lambda@Edge, and Node.js.
13
15
14
16
<!--@include: ../../sponsors.md-->
+2
docs/openapi-ts/plugins/joi.md
+2
docs/openapi-ts/plugins/joi.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1477).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Joi](https://joi.dev/) is the most powerful schema description language and data validator for JavaScript.
13
15
14
16
<!--@include: ../../sponsors.md-->
+2
docs/openapi-ts/plugins/koa.md
+2
docs/openapi-ts/plugins/koa.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1482).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Koa](https://koajs.com/) is a new web framework designed by the team behind Express, which aims to be a smaller, more expressive, and more robust foundation for web applications and APIs.
13
15
14
16
<!--@include: ../../sponsors.md-->
+2
docs/openapi-ts/plugins/msw.md
+2
docs/openapi-ts/plugins/msw.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1486).
10
10
:::
11
11
12
+
### About
13
+
12
14
[MSW](https://mswjs.io/) is an API mocking library that allows you to write client-agnostic mocks and reuse them across any frameworks, tools, and environments.
13
15
14
16
<!--@include: ../../sponsors.md-->
+2
docs/openapi-ts/plugins/nest.md
+2
docs/openapi-ts/plugins/nest.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1481).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Nest](https://nestjs.com/) is a progressive Node.js framework for building efficient, reliable and scalable server-side applications.
13
15
14
16
<!--@include: ../../sponsors.md-->
+2
docs/openapi-ts/plugins/nock.md
+2
docs/openapi-ts/plugins/nock.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1487).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Nock](https://github.com/nock/nock) is an HTTP server mocking and expectations library for Node.js.
13
15
14
16
<!--@include: ../../sponsors.md-->
+2
docs/openapi-ts/plugins/pinia-colada.md
+2
docs/openapi-ts/plugins/pinia-colada.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1242).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Pinia Colada](https://pinia-colada.esm.dev/) is the data fetching layer for Pinia.
13
15
14
16
<!--@include: ../../sponsors.md-->
+2
docs/openapi-ts/plugins/superstruct.md
+2
docs/openapi-ts/plugins/superstruct.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1489).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Superstruct](https://docs.superstructjs.org/) makes it easy to define interfaces and then validate JavaScript data against them.
13
15
14
16
<!--@include: ../../sponsors.md-->
+2
docs/openapi-ts/plugins/supertest.md
+2
docs/openapi-ts/plugins/supertest.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1488).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Supertest](https://github.com/ladjs/supertest) is a super-agent driven library for testing node.js HTTP servers using a fluent API.
13
15
14
16
<!--@include: ../../sponsors.md-->
+2
docs/openapi-ts/plugins/swr.md
+2
docs/openapi-ts/plugins/swr.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1479).
10
10
:::
11
11
12
+
### About
13
+
12
14
[SWR](https://swr.vercel.app/) is a strategy to first return the data from cache (stale), then send the fetch request (revalidate), and finally come with the up-to-date data.
13
15
14
16
<!--@include: ../../sponsors.md-->
+5
-1
docs/openapi-ts/plugins/tanstack-query.md
+5
-1
docs/openapi-ts/plugins/tanstack-query.md
···
13
13
TanStack Query plugin is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
14
14
:::
15
15
16
+
### About
17
+
16
18
[TanStack Query](https://tanstack.com/query) is a powerful asynchronous state management solution for TypeScript/JavaScript, React, Solid, Vue, Svelte, and Angular.
17
19
20
+
### Demo
21
+
18
22
<button class="buttonLink" @click="(event) => embedProject('hey-api-client-fetch-plugin-tanstack-react-query-example')(event)">
19
-
Live demo
23
+
Launch demo
20
24
</button>
21
25
22
26
## Features
+2
docs/openapi-ts/plugins/typebox.md
+2
docs/openapi-ts/plugins/typebox.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1475).
10
10
:::
11
11
12
+
### About
13
+
12
14
[TypeBox](https://github.com/sinclairzx81/typebox) is a JSON Schema type builder with static type resolution for TypeScript.
13
15
14
16
<!--@include: ../../sponsors.md-->
+2
docs/openapi-ts/plugins/valibot.md
+2
docs/openapi-ts/plugins/valibot.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1474).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Valibot](https://valibot.dev/) is the open source schema library for TypeScript with bundle size, type safety and developer experience in mind.
13
15
14
16
<!--@include: ../../sponsors.md-->
+2
docs/openapi-ts/plugins/yup.md
+2
docs/openapi-ts/plugins/yup.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1478).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Yup](https://github.com/jquense/yup) is a schema builder for runtime value parsing and validation.
13
15
14
16
<!--@include: ../../sponsors.md-->
+5
-1
docs/openapi-ts/plugins/zod.md
+5
-1
docs/openapi-ts/plugins/zod.md
···
9
9
This feature is in development! :tada: Try it out and provide feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues/876).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Zod](https://zod.dev/) is a TypeScript-first schema validation library with static type inference.
13
15
16
+
### Demo
17
+
14
18
<button class="buttonLink" @click="(event) => embedProject('hey-api-client-fetch-plugin-zod-example')(event)">
15
-
Live demo
19
+
Launch demo
16
20
</button>
17
21
18
22
## Features
+2
docs/openapi-ts/plugins/zustand.md
+2
docs/openapi-ts/plugins/zustand.md
···
9
9
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1480).
10
10
:::
11
11
12
+
### About
13
+
12
14
[Zustand](https://zustand-demo.pmnd.rs/) is a small, fast, and scalable bearbones state management solution.
13
15
14
16
<!--@include: ../../sponsors.md-->