apple/swift-openapi-generator
1,935 stars·171 forks·Swift·Apache-2.0·10 vuesswiftpackageindex.com/apple/swift-openapi-generator/documentation↗
Swift Openapi Generator
Le Swift OpenAPI Generator est un outil de build qui produit du code client et serveur Swift typé directement à partir de documents de spécification OpenAPI. En s'intégrant aux systèmes de build via des plugins natifs, il automatise la création d'interfaces fortement typées et de stubs de protocole qui mappent les opérations réseau aux méthodes natives, garantissant que le code de l'application reste strictement cohérent avec les schémas de données définis.
Le projet se distingue par une architecture orientée protocole qui découple la logique métier des implémentations de transport spécifiques. Il utilise une couche de transport enfichable et une interception de requête basée sur un middleware pour gérer les préoccupations transversales telles que l'authentification, la journalisation et la collecte de métriques. Cette conception permet aux développeurs de maintenir une couche de communication cohérente tout en restant agnostiques des frameworks web sous-jacents ou des détails de transmission réseau.
Le générateur prend en charge un large éventail de capacités, incluant le mappage de données piloté par schéma et la négociation de contenu pour divers formats. Il fournit une gestion efficace en mémoire des grandes charges utiles via un traitement de flux incrémentiel, ce qui permet l'échange de données complexes sans charger l'intégralité du contenu en mémoire. L'ensemble d'outils inclut également des utilitaires pour les tests de contrat automatisés et la génération de documentation interactive pour aider à valider les exigences des endpoints.
Features
- Swift Code Generators - Provides a build-time tool that generates type-safe Swift client and server code from OpenAPI specifications.
- Type-Safe Client Generators - Generates strongly-typed client code from API specifications to map network operations to native methods.
- Server Stub Generation - Generates server-side protocol stubs from API specifications to enforce request handling requirements.
- Schema-Driven Data Modeling - Automatically converts raw network payloads into strongly-typed structures based on defined API schemas.
- OpenAPI Client SDK Generators - Generates type-safe network clients directly from API specifications to ensure consistent communication with external services.
- Compile-Time Code Generation - Transforms API specification files into native source code during the build process to ensure strict type safety.
- Code from Specification Generators - Automates the production of source code from API specifications through build system integration.
- Request Interception Middleware - Wraps network calls in a chain of processing layers to inject cross-cutting concerns like authentication and logging.
- Request Interception Middleware - Implements middleware pipelines for intercepting, validating, and modifying network traffic to handle cross-cutting concerns.
- Server-Side Frameworks - Creates robust server stubs from OpenAPI documents to enforce request handling requirements in backend services.
- Memory-Efficient Data Streaming - Handles large request and response payloads incrementally to maintain memory efficiency during network exchanges.
- Incremental Data Streaming - Processes large data streams in chunks to maintain memory efficiency when handling high-volume network payloads.
- API Contract Validation - Verifies that network code remains strictly consistent with defined data schemas by validating implementations during the build.
- Build Plugin Code Generators - Integrates with build systems via native plugins to automate network code generation during compilation.
- Pluggable Transport Layers - Provides modular interfaces that allow swapping the underlying network transport implementation while remaining agnostic.
- Protocol-Oriented Injection - Uses abstract protocols to decouple business logic from specific transport implementations and web frameworks.
- Authentication Middlewares - Applies cross-cutting logic to network operations through modular and reusable middleware layers.
- Content Negotiation - Provides utilities for extending support for custom media types and encoding logic to ensure flexible communication.
- Interactive API Documentation UIs - Renders API specifications into interactive web-based interfaces for browsing and testing endpoints directly in the browser.
- Incremental Body Processing - Handles large request and response payloads incrementally to maintain memory efficiency during network communication.
