Otherwise known as the Typescript API Generator! This project aims to provide a simple single purpose generation for typescript api code and directories for front end projects. Currently using OpenApi3 specification.
Current code generators for react and typescript output code fashioned to a specific request library, but to accomodate multiple wrappers that developers may use in their own projects the library is likely fetch. This project aims to focus the generation to only one library: Axios. Ideally this prevents initial development to adapt the code generator to fit to your project.
If installing from a cloned repo, navigate to the root directory and then proceed with the following command:
yarn install -g/ npm install -g
npx taggem [-m] [--monolith] [path/to/input.y(a)ml] [path/to/output/]
This runs the generator in "monolith" mode.
This splits your api into multiple directories based on the open api tag assingments and
treats each tag as a servlet. It may not save your api, but it will save your eyes.
npx taggem [-s] [--service] [path/to/input.y(a)ml] [path/to/output/]
This runs the generator in "microservice mode" where your generated api code will be placed into a single directory of the same name as the api title. This ignores tags for further organization.
The code generator currently supports Axios version < 1 by default. In Axios version 1.0 header types were introduced as a breaking change. Passing in the Axios version your project uses as the v argument generates correct header types in the service files. See https://github.com/axios/axios/blob/v1.x/CHANGELOG.md#100---2022-10-04 for more information on 1.0 changes.
- One or more directories (depending on how the generator was invoked) containing the a file with typescript functions that will return a configuration object detailing how to access an api resource. E.g. (assuming --m),
exampleTagName/index.ts- the file containing api request configuration information.exampleTagNameModelTypes.ts- The exported typescript interfaces of open apischema.exampleTagNameModels.ts- The exported runtime representation of open apischema.
NOTE: The code generator will always create another directory called api to store the results so be wary when wanting to set your output directory to a similar name.
- Typescript
- Mustache
- Lodash
- Yargs
- JS-Yaml