Skip to content

Commit

Permalink
Merge branch 'main' into feat/zod-plugin-models
Browse files Browse the repository at this point in the history
  • Loading branch information
mrlubos authored Oct 19, 2024
2 parents 14c804f + 41e4259 commit 49b6e6e
Show file tree
Hide file tree
Showing 67 changed files with 1,635 additions and 1,452 deletions.
5 changes: 0 additions & 5 deletions .changeset/gentle-ladybugs-yawn.md

This file was deleted.

5 changes: 5 additions & 0 deletions .changeset/new-apples-suffer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@hey-api/docs': patch
---

docs: add Zod plugin page
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
<div align="center">
<img width="150" height="150" src="https://heyapi.vercel.app/logo.png" alt="Logo">
<h1 align="center"><b>OpenAPI Typescript</b></h1>
<p align="center">✨ Turn your OpenAPI specification into a beautiful TypeScript client.</p>
<img width="150" height="150" src="https://heyapi.dev/logo.png" alt="Logo">
<h1 align="center"><b>OpenAPI TypeScript</b></h1>
<p align="center">🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.</p>
</div>

Generate TypeScript interfaces, REST clients, and JSON Schemas from OpenAPI specifications.

[Live demo](https://stackblitz.com/edit/hey-api-example?file=openapi-ts.config.ts,src%2Fclient%2Fschemas.gen.ts,src%2Fclient%2Fservices.gen.ts,src%2Fclient%2Ftypes.gen.ts)

## Features
Expand All @@ -15,23 +13,24 @@ Generate TypeScript interfaces, REST clients, and JSON Schemas from OpenAPI spec
- supports both JSON and YAML input files
- generates TypeScript interfaces, REST clients, and JSON Schemas
- Fetch API, Axios, Angular, Node.js, and XHR clients available
- plugin ecosystem to reduce third-party boilerplate

## Documentation

Please visit our [website](https://heyapi.vercel.app/) for documentation, guides, migrating, and more.
Please visit our [website](https://heyapi.dev/) for documentation, guides, migrating, and more.

## Sponsoring

Love Hey API? Please consider becoming a [sponsor](https://github.com/sponsors/mrlubos).

## GitHub Integration (coming soon)

Automatically update your code when the APIs it depends on change. [Find out more](https://heyapi.vercel.app/openapi-ts/integrations.html).
Automatically update your code when the APIs it depends on change. [Find out more](https://heyapi.dev/openapi-ts/integrations.html).

## Migrating from OpenAPI Typescript Codegen?

Please read our [migration guide](https://heyapi.vercel.app/openapi-ts/migrating.html#openapi-typescript-codegen).
Please read our [migration guide](https://heyapi.dev/openapi-ts/migrating.html#openapi-typescript-codegen).

## Contributing

Want to get involved? Please refer to the [contributing guide](https://heyapi.vercel.app/contributing.html).
Want to get involved? Please refer to the [contributing guide](https://heyapi.dev/contributing.html).
28 changes: 22 additions & 6 deletions docs/.vitepress/config/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,15 @@ import { defineConfig } from 'vitepress';

export default defineConfig({
description:
'Turn your OpenAPI specification into a beautiful TypeScript client',
'🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.',
lang: 'en-US',
themeConfig: {
nav: [
{
link: 'https://github.com/sponsors/mrlubos',
text: 'Sponsor Hey API',
},
],
sidebar: [
{
items: [
Expand Down Expand Up @@ -36,27 +42,37 @@ export default defineConfig({
text: 'Clients',
},
{ link: '/openapi-ts/transformers', text: 'Transformers' },
{ link: '/openapi-ts/migrating', text: 'Migrating' },
],
text: 'Guides and Concepts',
},
{
items: [
{
link: '/openapi-ts/integrations',
text: 'Integrations <span class="soon">soon</span>',
},
{
link: '/openapi-ts/tanstack-query',
text: 'TanStack Query',
},
{
link: '/openapi-ts/zod',
text: 'Zod <span class="soon">soon</span>',
},
],
text: 'Plugins',
},
{
items: [
{
link: '/openapi-ts/integrations',
text: 'GitHub <span class="soon">soon</span>',
},
],
text: 'Integrations',
},
{
items: [
{ link: '/about', text: 'Philosophy' },
{ link: '/license', text: 'License' },
{ link: '/contributing', text: 'Contributing' },
{ link: '/openapi-ts/migrating', text: 'Migrating' },
],
text: '@hey-api',
},
Expand Down
6 changes: 3 additions & 3 deletions docs/.vitepress/config/shared.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ export default defineConfig({
'meta',
{
content:
'Turn your OpenAPI specification into a beautiful TypeScript client',
'🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.',
property: 'og:title',
},
],
['meta', { content: 'OpenAPI TypeScript', property: 'og:site_name' }],
['meta', { content: '/logo.png', property: 'og:image' }],
['meta', { content: 'https://heyapi.vercel.app', property: 'og:url' }],
['meta', { content: 'https://heyapi.dev', property: 'og:url' }],
[
'script',
{},
Expand All @@ -28,7 +28,7 @@ export default defineConfig({
].filter(Boolean) as HeadConfig[],
lastUpdated: false,
sitemap: {
hostname: 'https://heyapi.vercel.app',
hostname: 'https://heyapi.dev',
},
themeConfig: {
externalLinkIcon: true,
Expand Down
6 changes: 6 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# @hey-api/docs

## 0.6.1

### Patch Changes

- [#1151](https://github.com/hey-api/openapi-ts/pull/1151) [`587791d`](https://github.com/hey-api/openapi-ts/commit/587791dfede0167fbed229281467e4c4875936f5) Thanks [@mrlubos](https://github.com/mrlubos)! - fix: update website domain, add license documentation

## 0.6.0

### Minor Changes
Expand Down
36 changes: 19 additions & 17 deletions docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,30 @@ description: Hello from Hey API.
<script setup>
import { VPTeamMembers } from 'vitepress/theme'

const members = [
const hallOfFame = [
{
avatar: 'https://github.com/mrlubos.png',
name: 'Lubos',
title: 'Author',
avatar: 'https://github.com/ferdikoomen.png',
name: 'Ferdi Koomen',
links: [
{ icon: 'github', link: 'https://github.com/mrlubos' },
{ icon: 'twitter', link: 'https://twitter.com/mrlubos' }
{ icon: 'github', link: 'https://github.com/ferdikoomen' },
],
sponsor: 'https://github.com/sponsors/mrlubos',
title: 'OpenAPI TypeScript Codegen',
},
{
avatar: 'https://github.com/nicolas-chaulet.png',
name: 'Nicolas Chaulet',
links: [
{ icon: 'github', link: 'https://github.com/nicolas-chaulet' },
],
title: 'Made the Hey API fork',
},
{
avatar: 'https://github.com/jordanshatford.png',
name: 'Jordan',
title: 'Maintainer',
name: 'Jordan Shatford',
links: [
{ icon: 'github', link: 'https://github.com/jordanshatford' },
],
title: 'Maintainer and Contributor',
},
]
</script>
Expand All @@ -40,16 +46,12 @@ Typically, developers of such applications want to:

Doing any of these steps manually quickly becomes a huge time sink as your project grows and APIs evolve. Ideally, you want to spend most time on your application. Hey API allows you to do just that.

We're constantly learning about the ways in which you use our tools. If you have any feedback, please [email us](mailto:[email protected]), [open an issue](https://github.com/hey-api/openapi-ts/issues), or [join a discussion](https://github.com/hey-api/openapi-ts/discussions).

## Team

<VPTeamMembers size="small" :members="members" />
We're constantly learning about the ways in which you use our tools. If you have any feedback, please [email us](mailto:[email protected]), [open an issue](https://github.com/hey-api/openapi-ts/issues), or [join a discussion](https://github.com/orgs/hey-api/discussions).

Our core members are [Jordan](https://github.com/jordanshatford) and [Lubos](https://lmen.us/), but we also accept external contributions. Please see our [contributing](./contributing) guide for more information.
## Hall of Fame

## Acknowledgements
These are the people with significant contributions to Hey API. A special thank you goes to [Ferdi Koomen](https://madebyferdi.com/) for allowing us to use the original source code from OpenAPI TypeScript Codegen. None of this would've been possible without you!

None of this would be possible without [Ferdi Koomen](https://madebyferdi.com/) and the contributors to OpenAPI TypeScript Codegen throughout the years. We want to say a huge thank you to all of you, and promise to continue the legacy of the original project.
<VPTeamMembers size="small" :members="hallOfFame" />

<!--@include: ./sponsorship.md-->
41 changes: 9 additions & 32 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,40 +7,17 @@ description: Learn how to contribute to Hey API.

Thank you for considering contributing to Hey API. In order to increase the likelihood of your changes being merged, first open an issue if one does not already exist. Once an issue exists, let us know you'd like to work on it. We will confirm whether we're looking to resolve the issue and provide you with guidance if required. This is to ensure our codebase remains in good state and all features contribute to Hey API's [objectives](/about).

## Development Requirements
## Prerequisites

- [git](https://git-scm.com/)
- [node](https://nodejs.org/en) (version `18.0` or higher)
- [pnpm](https://pnpm.io/) (version `8` or higher)
You should have a working knowledge of [git](https://git-scm.com/), [node](https://nodejs.org/en), and [pnpm](https://pnpm.io/).

## Install Dependencies
## Guidelines

We use pnpm as our package manager. You can setup and install all dependencies running the following command:
Your [pull request](https://help.github.com/articles/using-pull-requests) must:

```sh
pnpm install
```
- address a single issue or add a single item of functionality
- contain a clean history of small, incremental, logically separate commits, with no merge commits
- use clear commit messages
- be possible to merge automatically

## Pull Request Guidelines

If you are unfamiliar with GitHub Pull Requests, please read the following documentation:
https://help.github.com/articles/using-pull-requests

**Your Pull Request must:**

- Address a single issue or add a single item of functionality.
- Contain a clean history of small, incremental, logically separate commits, with no merge commits.
- Use clear commit messages.
- Be possible to merge automatically.

## Submitting a Pull Request

1. Make your changes in a new git branch: `git checkout -b my-fix-branch main`
1. Create your patch or feature
1. Ensure the builds work by running: `pnpm build`
1. Ensure the tests will pass by running: `pnpm test`
1. Ensure the code is formatted by running: `pnpm lint:fix`
1. Ensure that you create a changeset if required by running: `pnpm changeset`
1. Commit your changes using a descriptive commit message

After your Pull Request is created, it will automatically be built and tested in GitHub actions. Once successful, it will be ready for review.
<!--@include: ./sponsorship.md-->
Loading

0 comments on commit 49b6e6e

Please sign in to comment.