⭐⭐⭐ If you would like to contribute, please refer to To do list and a list of open tasks.:star::star::star:

Support OpenApi v3, swagger v2 and postman collection

An auto typescript/javascript/kotlin code generator from APIs doc. Each endpoint will be created as a function, full type base. Supported

• Generating a function for every apis
• Generating all types, interfaces and enums which used in apis
• React hooks.
• SignalR hub.
• Generating mock data.

For Example: Get method of '/Account' path will be this code in services.ts

import { getAccount } from "./services";

const response = await getAccount({ id: 1234 });

$ yarn add swagger-typescript prettier -D && yarn add axios

Before running, add your config to swagger.config.json

{
  "url": "http://example.com/api/swagger.json",
  "dir": "./services",
  "prefix": "/api"
}

yarn swag-ts

more

baseConfig

const baseConfig: AxiosRequestConfig = {
  baseURL: "", // <--- Add your base url
  //other static configs
};

Now you can use APIs, So for advanced config read below.

For Example:

{
  "$schema": "https://raw.githubusercontent.com/hosseinmd/swagger-typescript/master/schema/v6.json",
  "url": "http://example.com/api/swagger.json",
  "dir": "./services",
  "prettierPath": ".prettierrc",
  "language": "typescript"
}

• enum ReferralStatus {Successed="Successed","Error"="Error"}
• type ReferralStatus="Successed" | "Error"; // generateEnumAsType = true |

The config.ts file automatically will be created after first run. You could change this file for customization. Don't change other files, if you want another config create Issue or PR.

• getAxiosInstance

  getAxiosInstance used for create an instance of axios request you can customize that for what you needed

• baseConfig

  baseConfig used for get static configs and headers. if you need some dynamic configs like add authentication to headers use requestConfig.headers.authorization into of axiosInstance.interceptors.request.use function.

const { generate } = require("swagger-typescript");

generate(config);
// or
generate(); // will be use ./swagger.config.json

In some situation teams have parallel backend development which cause conflict when updating swagger for solving this we have partially update, you can update your service just for a few tags and keep other old services codes.

For Doing this you need to add this to your swagger.config.json

"keepJson": true,

This code will keep previous JSON for updating partially.

Run $ yarn swag-ts with your base backend, for example develop branch

Others need to pull this changes

Now you can update Tag1 and Tag2 $ yarn swag-ts Tag1 Tag2.

if you have multiple gateway in your project you could handle it by add array of config in swagger.config.json

[
  {
    "$schema": "https://raw.githubusercontent.com/hosseinmd/swagger-typescript/master/schema/v6.json",
    "url": "http://example1.com/api/swagger.json",
    "dir": "./service1",
    "prettierPath": ".prettierrc",
    "language": "typescript"
  },
  {
    "$schema": "https://raw.githubusercontent.com/hosseinmd/swagger-typescript/master/schema/v6.json",
    "url": "http://example2.com/api/swagger.json",
    "dir": "./service2",
    "prettierPath": ".prettierrc",
    "language": "typescript"
  }
]

if you are managing project by multiple branch like gitflow, you need to update swagger based on you working branch or parent branch (for example your parent is develop if you create a branch from develop).

For Example:

{
  "url": [
    {
      "branch": "master",
      "url": "http:/example.com/api/swagger.json"
    },
    {
      "branch": "develop",
      "url": "http://stage.example.com/api/swagger.json"
    }
  ]
}

to generate swagger for develop run yarn swag-ts --branch=develop or your branch name should be develop or develop/something

why-you-should-use-swagger-typescript-for-generate-apis-code