Giter Club home page Giter Club logo

openapi-typegen's Introduction

Openapi Typegen

Build Status Coverage Status npm version

Generates typescript code to access your api based on the openapi (swagger) json files. The generated files are completely typesafe. This library supports only openapi schemas with the version 3.

Installation

With npm

$ npm install --global openapi-typegen`

With yarn

$ yarn global add openapi-typegen

Usage

1. Generate the files with the cli tool

$ typegen --src <path-or-url-to-schema> --out <output-directory>

For example

$ typegen --src http://localhost:8080/v2/api-docs --out ./generated 

2. Use the generated files in your application

import { createApi } from './generated/create-api';

const api = createApi({
  baseUrl: 'http://localhost:8000/api' // Override the base url the default is the url from the first server in the schema
});

// Now you can use the api as the following. The function names will be generated
// based on the operationIds
api.findPetsByTags({
  query: {
    tags: ['available']
  }
})
  .then(response => console.log(`Found pets ${response.data}`))
  .catch(error => console.error('Error while searching pets'));

Example

For an example of the generated files please take a look at the pet-store example.

openapi-typegen's People

Contributors

tobias-walle avatar tobias-walle-mw avatar dependabot[bot] avatar

Stargazers

Fernando de los Ríos Sánchez avatar Colin Perepelken avatar Karol Wąsik avatar Anton Khlynovskiy avatar 管斌瑞 avatar

Watchers

 avatar

Forkers

seamuncle

openapi-typegen's Issues

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.


Good luck with your project ✨

Your semantic-release bot 📦🚀

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.