{"id":47891113,"url":"https://github.com/osodevops/akka-openapi-maven-plugin","last_synced_at":"2026-04-04T03:06:12.510Z","repository":{"id":334697245,"uuid":"1141901058","full_name":"osodevops/akka-openapi-maven-plugin","owner":"osodevops","description":"Maven plugin to generate OpenAPI 3.1 specifications from Akka SDK HTTP endpoint annotations","archived":false,"fork":false,"pushed_at":"2026-03-20T06:05:35.000Z","size":229,"stargazers_count":1,"open_issues_count":15,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-20T22:48:29.889Z","etag":null,"topics":["akka","akka-sdk","code-generation","java","maven-plugin","openapi","openapi-generator","swagger"],"latest_commit_sha":null,"homepage":"https://search.maven.org/artifact/sh.oso/akka-openapi-maven-plugin","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/osodevops.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-25T16:19:19.000Z","updated_at":"2026-03-20T06:05:42.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/osodevops/akka-openapi-maven-plugin","commit_stats":null,"previous_names":["osodevops/akka-openapi-maven-plugin"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/osodevops/akka-openapi-maven-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osodevops%2Fakka-openapi-maven-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osodevops%2Fakka-openapi-maven-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osodevops%2Fakka-openapi-maven-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osodevops%2Fakka-openapi-maven-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osodevops","download_url":"https://codeload.github.com/osodevops/akka-openapi-maven-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osodevops%2Fakka-openapi-maven-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31385942,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T01:22:39.193Z","status":"online","status_checked_at":"2026-04-04T02:00:07.569Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["akka","akka-sdk","code-generation","java","maven-plugin","openapi","openapi-generator","swagger"],"created_at":"2026-04-04T03:06:11.121Z","updated_at":"2026-04-04T03:06:12.500Z","avatar_url":"https://github.com/osodevops.png","language":"Java","readme":"# Akka OpenAPI Maven Plugin\n\n[![Maven Central](https://img.shields.io/maven-central/v/sh.oso/akka-openapi-maven-plugin.svg)](https://search.maven.org/artifact/sh.oso/akka-openapi-maven-plugin)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Build](https://github.com/osodevops/akka-openapi-maven-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/osodevops/akka-openapi-maven-plugin/actions/workflows/ci.yml)\n\nGenerate OpenAPI 3.1 specifications from [Akka SDK](https://doc.akka.io/sdk/) HTTP endpoint annotations at compile time.\n\n## Features\n\n- **Zero Configuration** - Works out-of-the-box with sensible defaults\n- **Compile-Time Generation** - No runtime overhead, perfect for serverless/containers\n- **OpenAPI 3.1** - Latest specification with full JSON Schema support\n- **Automatic Schema Generation** - POJOs converted to JSON schemas automatically\n- **JavaDoc Extraction** - Uses your existing documentation for descriptions\n- **Validation** - Ensures generated specs are valid before writing\n\n## Quick Start\n\nAdd the plugin to your `pom.xml`:\n\n```xml\n\u003cbuild\u003e\n    \u003cplugins\u003e\n        \u003cplugin\u003e\n            \u003cgroupId\u003esh.oso\u003c/groupId\u003e\n            \u003cartifactId\u003eakka-openapi-maven-plugin\u003c/artifactId\u003e\n            \u003cversion\u003e1.0.0-SNAPSHOT\u003c/version\u003e\n            \u003cexecutions\u003e\n                \u003cexecution\u003e\n                    \u003cgoals\u003e\n                        \u003cgoal\u003egenerate\u003c/goal\u003e\n                    \u003c/goals\u003e\n                \u003c/execution\u003e\n            \u003c/executions\u003e\n        \u003c/plugin\u003e\n    \u003c/plugins\u003e\n\u003c/build\u003e\n```\n\nRun:\n\n```bash\nmvn compile\n```\n\nYour OpenAPI specification will be generated at `target/openapi.yaml`.\n\n## Example\n\nGiven an Akka SDK endpoint:\n\n```java\n/**\n * Customer management endpoint.\n */\n@HttpEndpoint(\"/customers\")\npublic class CustomerEndpoint {\n\n    /**\n     * Get a customer by ID.\n     * @param id the customer unique identifier\n     * @return the customer or 404 if not found\n     */\n    @Get(\"/{id}\")\n    public Customer getCustomer(String id) {\n        // ...\n    }\n\n    /**\n     * Create a new customer.\n     */\n    @Post\n    public Customer createCustomer(CreateCustomerRequest request) {\n        // ...\n    }\n}\n```\n\nThe plugin generates:\n\n```yaml\nopenapi: 3.1.0\ninfo:\n  title: My API\n  version: 1.0.0\npaths:\n  /customers/{id}:\n    get:\n      summary: Get a customer by ID.\n      operationId: getCustomer\n      parameters:\n        - name: id\n          in: path\n          required: true\n          description: the customer unique identifier\n          schema:\n            type: string\n      responses:\n        '200':\n          description: Success\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Customer'\n        '404':\n          description: Not Found\n  /customers:\n    post:\n      summary: Create a new customer.\n      operationId: createCustomer\n      requestBody:\n        required: true\n        content:\n          application/json:\n            schema:\n              $ref: '#/components/schemas/CreateCustomerRequest'\n      responses:\n        '201':\n          description: Created\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Customer'\ncomponents:\n  schemas:\n    Customer:\n      type: object\n      properties:\n        id:\n          type: string\n        name:\n          type: string\n        email:\n          type: string\n          format: email\n    CreateCustomerRequest:\n      type: object\n      required:\n        - name\n        - email\n      properties:\n        name:\n          type: string\n        email:\n          type: string\n          format: email\n```\n\n## Configuration\n\n```xml\n\u003cplugin\u003e\n    \u003cgroupId\u003esh.oso\u003c/groupId\u003e\n    \u003cartifactId\u003eakka-openapi-maven-plugin\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.0\u003c/version\u003e\n    \u003cconfiguration\u003e\n        \u003c!-- Output settings --\u003e\n        \u003coutputFile\u003e${project.build.directory}/openapi.yaml\u003c/outputFile\u003e\n        \u003coutputFormat\u003eyaml\u003c/outputFormat\u003e \u003c!-- yaml or json --\u003e\n\n        \u003c!-- API metadata --\u003e\n        \u003capiTitle\u003e${project.name}\u003c/apiTitle\u003e\n        \u003capiVersion\u003e${project.version}\u003c/apiVersion\u003e\n        \u003capiDescription\u003e${project.description}\u003c/apiDescription\u003e\n\n        \u003c!-- Package scanning --\u003e\n        \u003cscanPackages\u003e\n            \u003cpackage\u003ecom.example.endpoints\u003c/package\u003e\n        \u003c/scanPackages\u003e\n\n        \u003c!-- Server definitions --\u003e\n        \u003cservers\u003e\n            \u003cserver\u003e\n                \u003curl\u003ehttps://api.example.com\u003c/url\u003e\n                \u003cdescription\u003eProduction\u003c/description\u003e\n            \u003c/server\u003e\n        \u003c/servers\u003e\n\n        \u003c!-- Validation --\u003e\n        \u003cfailOnValidationError\u003etrue\u003c/failOnValidationError\u003e\n\n        \u003c!-- Skip generation --\u003e\n        \u003cskip\u003efalse\u003c/skip\u003e\n    \u003c/configuration\u003e\n\u003c/plugin\u003e\n```\n\n## Supported Akka SDK Annotations\n\n| Annotation | OpenAPI Mapping |\n|------------|-----------------|\n| `@HttpEndpoint(path)` | Base path for all operations |\n| `@Get`, `@Post`, `@Put`, `@Delete`, `@Patch` | HTTP methods |\n| Path parameters (e.g., `/{id}`) | `parameters[in=path]` |\n| Last complex type parameter | `requestBody` |\n| Method return type | Response schema |\n| JavaDoc comments | `summary` and `description` |\n\n## Custom Annotations\n\nFor additional control, use the optional custom annotations:\n\n```java\n@HttpEndpoint(\"/customers\")\n@OpenAPITag(name = \"Customers\", description = \"Customer management\")\npublic class CustomerEndpoint {\n\n    @Get(\"/{id}\")\n    @OpenAPIResponse(status = \"200\", description = \"Customer found\")\n    @OpenAPIResponse(status = \"404\", description = \"Customer not found\")\n    public Customer getCustomer(String id) {\n        // ...\n    }\n}\n```\n\n## Documentation\n\n- [Getting Started](docs/GETTING_STARTED.md)\n- [Configuration Reference](docs/CONFIGURATION.md)\n- [Examples](docs/EXAMPLES.md)\n- [Troubleshooting](docs/TROUBLESHOOTING.md)\n\n## Requirements\n\n- Java 17 or later\n- Maven 3.6.3 or later\n- Akka SDK 3.0.0 or later\n\n## Contributing\n\nContributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.\n\n## License\n\nThis project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- [Akka SDK](https://doc.akka.io/sdk/) - The Akka platform for building reactive applications\n- [Swagger Core](https://github.com/swagger-api/swagger-core) - OpenAPI implementation for Java\n- [ClassGraph](https://github.com/classgraph/classgraph) - Fast classpath scanner\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosodevops%2Fakka-openapi-maven-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosodevops%2Fakka-openapi-maven-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosodevops%2Fakka-openapi-maven-plugin/lists"}