Skip to content

Commit

Permalink
docs: iterate on the documentation
Browse files Browse the repository at this point in the history
- quicker quick start
- shorter pages
- remove out of date architecture page
- add more links
  • Loading branch information
mnahkies committed Nov 24, 2024
1 parent ffb22b3 commit 9456087
Show file tree
Hide file tree
Showing 21 changed files with 315 additions and 2,701 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# @nahkies/openapi-code-generator

![CI/CD](https://github.com/mnahkies/openapi-code-generator/actions/workflows/ci.yml/badge.svg)
[![CI/CD](https://github.com/mnahkies/openapi-code-generator/actions/workflows/ci.yml/badge.svg)](https://github.com/mnahkies/openapi-code-generator/actions?query=branch%3Amain+event%3Apush)
[![npm](https://img.shields.io/npm/v/@nahkies/openapi-code-generator.svg)](https://www.npmjs.com/package/@nahkies/openapi-code-generator)

`@nahkies/openapi-code-generator` is a CLI tool that aims to generate high quality typescript client SDK's,
and API server scaffolding (routing, validation, serialization) from OpenAPI 3 specifications.
and API server scaffolding (routing, validation, serialization) from api specifications.

Currently, [OpenAPI 3.0](https://swagger.io/specification/v3), [OpenAPI 3.1](https://swagger.io/specification/),
and [TypeSpec](https://typespec.io/) are supported an input specifications.
and [TypeSpec](https://typespec.io/) are supported as input specifications.

With typescript templates for [koa](https://openapi-code-generator.nahkies.co.nz/guides/server-templates/typescript-koa), [fetch](https://openapi-code-generator.nahkies.co.nz/guides/client-templates/typescript-fetch), [axios](https://openapi-code-generator.nahkies.co.nz/guides/client-templates/typescript-axios), and [angular](https://openapi-code-generator.nahkies.co.nz/guides/client-templates/typescript-angular) currently available.

The [fetch](https://openapi-code-generator.nahkies.co.nz/guides/client-templates/typescript-fetch) and [axios](https://openapi-code-generator.nahkies.co.nz/guides/client-templates/typescript-axios) templates work great in conjunction with [react-query](https://tanstack.com/query/latest)

<!-- toc -->

Expand Down Expand Up @@ -47,8 +51,6 @@ Scripts to refresh the test data live in [./scripts](./scripts)

Contributing guidelines can be found in [./CONTRIBUTING.md](./CONTRIBUTING.md).

An overview of the codebase architecture is [available here](https://openapi-code-generator.nahkies.co.nz/reference/architecture)

## License

See [./LICENSE](./LICENSE)
MIT Licensed, see [./LICENSE](./LICENSE)
Loading

0 comments on commit 9456087

Please sign in to comment.