-
-
Notifications
You must be signed in to change notification settings - Fork 113
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
25 changed files
with
225 additions
and
804 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "openapi-ts-docs": minor | ||
| --- | ||
|
|
||
| docs: add integrations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,11 @@ | ||
| import { defineConfig } from 'vitepress'; | ||
|
|
||
| import en from './en'; | ||
| import shared from './shared'; | ||
|
|
||
| import { withMermaid } from 'vitepress-plugin-mermaid'; | ||
|
|
||
| export default withMermaid({ | ||
| export default defineConfig({ | ||
| ...shared, | ||
| locales: { | ||
| root: { label: 'English', ...en }, | ||
| }, | ||
| /** | ||
| * mermaid fix | ||
| * {@link https://github.com/mermaid-js/mermaid/issues/4320} | ||
| */ | ||
| vite: { | ||
| optimizeDeps: { | ||
| include: [ | ||
| 'mermaid' | ||
| ] | ||
| } | ||
| } | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| title: About | ||
| title: Philosophy | ||
| description: Hello from Hey API. | ||
| --- | ||
|
|
||
|
|
@@ -13,18 +13,8 @@ Typically, developers of such applications want to: | |
| - send and fetch this data from server in a typesafe way | ||
| - build further abstractions on top of this data | ||
|
|
||
| ```mermaid | ||
| flowchart LR | ||
| id1(Application) --> id2(API types) --> id3(API request wrapper) --> id4(REST endpoint) | ||
| ``` | ||
|
|
||
| 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. | ||
|
|
||
| ```mermaid | ||
| flowchart LR | ||
| id1(Application) --> id2(Hey API) --> id3(REST endpoint) | ||
| ``` | ||
|
|
||
| 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 | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| title: Integrations | ||
| description: Automate your client generation. | ||
| --- | ||
|
|
||
| # Integrations <span class="soon">Soon</span> | ||
|
|
||
| Integrations allow you to automate your client generation workflow. We suggest using them with `openapi-ts`, but you can use any codegen. | ||
|
|
||
| <br/> | ||
|
|
||
| ::: tip | ||
| Integrations are in beta. If you'd like to be one of the first users, [send us an email](mailto:[email protected]). | ||
| ::: | ||
|
|
||
| ## Upload OpenAPI Spec | ||
|
|
||
| More information will be provided as we finalize the tooling. | ||
|
|
||
| ## Configure Clients | ||
|
|
||
| More information will be provided as we finalize the tooling. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.