DOCSEARCHbyAlgolia
Submit Docs

Swagger Codegen

repository·master·Indexed 12 days ago

https://github.com/swagger-api/swagger-codegen

A tool for automatically generating API client libraries (SDKs), server stubs, and documentation from OpenAPI Specifications. Includes the swagger-codegen-maven-plugin (version 2.3.1) for Maven integration, a CLI for generating Bash client scripts, and support for server implementations such as JAX-RS CXF 3, Lumen, and Rails 5.

Tokens
536.9K
Snippets
2K
Records
2.7K
Agent score
84%

What's inside Swagger Codegen

  1. Overview of PetApi methods

    master

    The PetApi provides several methods for managing pets in the store. All URIs are relative to http://petstore.swagger.io:80/v2.

    MethodHTTP requestDescription
    addPetPOST /petAdd a new pet to the store
    deletePetDELETE /pet/{petId}Deletes a pet
    findPetsByStatusGET /pet/findByStatusFinds Pets by status
    findPetsByTagsGET /pet/findByTagsFinds Pets by tags
    getPetByIdGET /pet/{petId}Find pet by ID
    updatePetPUT /petUpdate an existing pet
    updatePetWithFormPOST /pet/{petId}Updates a pet in the store with form data
    uploadFilePOST /pet/{petId}/uploadImageUploads an image

  5. Overview of the TypeScript-Aurelia generator

    master

    The TypeScript-Aurelia generator produces a TypeScript/JavaScript client designed to be injectable by the Aurelia framework.

    Supported Environments:

    • Node.js
    • Webpack
    • Browserify

    Language & Module Support:

    • Language Levels: ES5 (requires a Promises/A+ library) or ES6.
    • Module Systems: CommonJS or ES6 module system.
    • Usage: Compatible with both TypeScript and JavaScript. In TypeScript projects, type definitions are automatically resolved via package.json.

  6. Overview of UserApi

    master

    The UserApi provides methods for managing users within the Petstore system. All requests are relative to the base URL http://petstore.swagger.io:80/v2.

    Available operations include:

    • POST /user: Create a user
    • POST /user/createWithArray: Create multiple users via an array
    • POST /user/createWithList: Create multiple users via a list
    • DELETE /user/{username}: Delete a user
    • GET /user/{username}: Retrieve a user by name
    • GET /user/login: Log a user in
    • GET /user/logout: Log a user out
    • PUT /user/{username}: Update an existing user

  9. Overview of the Elm API client sample

    master

    This repository contains a sample Elm API client generated from the Petstore server specification. It serves as an example of how to use swagger-codegen to generate a functional API client in Elm by consuming a remote swagger-spec.

    Key Details:

    • API Version: 1.0.0
    • Generator: io.swagger.codegen.languages.ElmClientCodegen
    • Testing Authorization: You can use the API key special-key to test authorization filters within the Petstore API.

  12. Overview of @swagger/typescript-fetch-petstore

    master

    The @swagger/typescript-fetch-petstore@1.0.0 generator produces a TypeScript/JavaScript client library that uses the Fetch API.

    Supported Environments:

    • Node.js
    • Webpack
    • Browserify

    Language & Module Support:

    • Language Level: ES6 or ES5 (Note: ES5 requires a Promises/A+ library to be installed).
    • Module Systems: CommonJS or ES6 module system.
    • Usage: Compatible with both TypeScript and JavaScript. In TypeScript projects, type definitions are automatically resolved via package.json.