swagger-api/swagger-codegen

★ 17,737MustacheAudience · developerComplexity · 3/5Setup · moderate

Mindmap

mindmap
  root((repo))
    What it does
      Read OpenAPI spec
      Generate client code
      Generate server stubs
    Generated outputs
      Client libraries
      Server stubs
      HTML docs
    Languages supported
      Java Python Go
      TypeScript PHP
      Ruby C# Swift
    How to run
      CLI JAR file
      Online generator API

mindmap root((repo)) What it does Read OpenAPI spec Generate client code Generate server stubs Generated outputs Client libraries Server stubs HTML docs Languages supported Java Python Go TypeScript PHP Ruby C# Swift How to run CLI JAR file Online generator API

Click or tap to explore — scroll the page freely

Things people build with this

USE CASE 1

Generate a ready-to-use Python or Go client library from your OpenAPI spec so API consumers skip writing HTTP calls by hand.

USE CASE 2

Create server stub code in a framework of your choice to scaffold the server-side structure defined in an OpenAPI file.

USE CASE 3

Generate HTML documentation directly from an OpenAPI spec to share with your team or external API consumers.

USE CASE 4

Keep client libraries in sync with a changing API by regenerating from the updated spec instead of manually patching code.

Tech stack

JavaMustacheOpenAPIYAMLJSON

Getting it running

Difficulty · moderate Time to first run · 30min

Requires Java to run the JAR file locally, the online generator API avoids any local installation.

In plain English

Swagger Codegen is a tool that automatically generates code from an API description file. An API (application programming interface) is a defined way for software systems to talk to each other, and OpenAPI (also known as Swagger) is a popular standard for describing what an API does, what endpoints exist, what data they accept, what they return, in a machine-readable format (usually a JSON or YAML file). The problem it solves is tedious boilerplate: once you have an OpenAPI description of your API, writing client libraries (code that calls the API in different programming languages) and server stubs (skeleton code that defines the server-side structure) by hand is repetitive and error-prone. Swagger Codegen reads your OpenAPI file and generates this code automatically, so your API consumers get a ready-to-use library in their language rather than having to hand-craft HTTP calls. The tool supports generating API client libraries in a range of languages including Java, Python, Go, JavaScript, TypeScript, PHP, Ruby, C#, Kotlin, Swift, Dart, R, and Scala. For server stubs, it supports frameworks across several languages. It can also generate HTML documentation from the same API description. You run it as a command-line tool (distributed as a Java JAR file) pointing at your OpenAPI spec, selecting the target language, and specifying an output directory. An online generator API is also available if you do not want to run it locally. The project is open source and used in workflows where teams want to keep their client code in sync with a changing API definition. The full README is longer than what was provided.

Copy-paste prompts

Prompt 1

I have an OpenAPI YAML file for my REST API. Show me the swagger-codegen CLI command to generate a Python client library and explain what the output folder contains.

Prompt 2

Using swagger-codegen, generate a TypeScript client for my OpenAPI spec. How do I customize the generated package name and API base URL?

Prompt 3

My API spec changed and I need to regenerate Java and Go client libraries with swagger-codegen without losing my custom modifications. What is the right workflow?

Prompt 4

How do I use the swagger-codegen online generator API instead of running the JAR locally?

Open on GitHub → Explain another repo

← swagger-api on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.