swagger-api/swagger-codegen
Swagger Codegen
Swagger Codegen is a template-driven engine and multi-language toolkit used to generate API client SDKs, server stubs, and human-readable documentation from OpenAPI specifications. It translates these specifications into functional libraries and boilerplate routing code across various target programming languages.
The tool utilizes a pluggable generator module system and an integrated template engine, allowing for the customization of generated source code and the creation of new language-specific generators. It supports flexible specification sourcing via local files, remote HTTP endpoints, or a hosted web application.
The project covers a broad range of automation capabilities, including integration with build tools and CI/CD pipelines, containerized CLI execution, and configurable type mapping. It also provides features for artifact filtering, external model mapping to prevent duplicate definitions, and the ability to deploy generated SDKs directly to GitHub.
Features
- Client Library Generation - Generates language-specific libraries from OpenAPI specifications to automate request handling and typed interfaces.
- Client Library Generators - Provides a toolkit for automating the creation of language-specific client SDKs from OpenAPI specifications.
- Server Stub Generation - Generates boilerplate server code and routing from OpenAPI specifications to establish RESTful services.
- API Code Generators - Generates client libraries and server stubs by processing API definition files stored on the local filesystem.
- API Documentation Generators - Automatically generates human-readable technical documentation from API specifications.
- Documentation Generators - Transforms OpenAPI specifications into complete, human-readable documentation websites.
- Server Boilerplate Generators - Automates the creation of boilerplate server code and routing based on OpenAPI specifications to accelerate RESTful service development.
- Source Code Templates - Produces language-specific source code by merging parsed API specifications with predefined text templates.
- Automated API Documentation - Produces technical specifications and documentation directly from OpenAPI definitions to ensure synchronization with code.
- OpenAPI Specification Parsers - Parses OpenAPI and Swagger specifications to translate them into formats compatible with various language generators.
- Multi-Language Client Generation - Translates a single API specification into multiple official client libraries across various programming languages.
- API Client SDK Generators - Provides an engine for creating tailored, type-safe client SDKs based on API specifications.
- Remote Specification Fetching - Allows generating API clients and server stubs by fetching specifications from remote HTTP endpoints.
- Pluggable Generator Architectures - Organizes language-specific logic into discrete modules that implement a common interface for creating clients and servers.
- Type Mapping Utilities - Implements configurable type mapping to translate OpenAPI data types into target language primitives.
- Language Type Mappers - Resolves API specification data types to target language primitives through a configurable map of type definitions.
- API Contract Synchronization - Automates the generation of clients and servers within build pipelines to maintain consistency with the API contract.
- Generation Parameter Overrides - Allows overriding default package names, naming prefixes, and library templates via configuration files.
- Build Tool Integrations - Integrates with standard build tools to automatically produce API clients and server stubs during the build cycle.
- CI CD Pipelines - Automates code generation within version control workflows and build pipelines to keep clients and servers in sync with specifications.
- Specification AST Generation - Translates API specifications into an internal object model to isolate the input format from the output generation logic.
- Custom Generator Registries - Provides a boilerplate project structure and registration mechanism to build new language-specific generators.
- Generation Templates - Provides customizable templates for injecting language-specific logic into the code generation pipeline.
- API Client Development Tools - Generates client libraries from Swagger specifications.
- Integration and Admin Frameworks - Automates generation of client libraries and server stubs.
