{"id":15091520,"url":"https://github.com/chhorz/oas-generator","last_synced_at":"2025-04-12T07:11:27.658Z","repository":{"id":38317315,"uuid":"124779417","full_name":"chhorz/oas-generator","owner":"chhorz","description":"Build-Time generation of OpenAPI specification files","archived":false,"fork":false,"pushed_at":"2024-04-08T17:03:27.000Z","size":8672,"stargazers_count":2,"open_issues_count":6,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-08T21:18:11.007Z","etag":null,"topics":["annotation-processor","java","oas","openapi"],"latest_commit_sha":null,"homepage":"https://chhorz.github.io/oas-generator/","language":"HTML","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/chhorz.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":"CONTRIBUTING.adoc","funding":null,"license":"LICENSE.txt","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}},"created_at":"2018-03-11T17:09:28.000Z","updated_at":"2024-04-15T15:47:16.344Z","dependencies_parsed_at":"2023-02-18T03:46:00.188Z","dependency_job_id":"3ba77d17-054b-469f-99cb-c0950370dddf","html_url":"https://github.com/chhorz/oas-generator","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chhorz%2Foas-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chhorz%2Foas-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chhorz%2Foas-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chhorz%2Foas-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chhorz","download_url":"https://codeload.github.com/chhorz/oas-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248530575,"owners_count":21119600,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["annotation-processor","java","oas","openapi"],"created_at":"2024-09-25T10:41:34.870Z","updated_at":"2025-04-12T07:11:27.637Z","avatar_url":"https://github.com/chhorz.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"= OAS Generator\n:author: Christian Horz\n:icons: font\n\nimage:https://github.com/chhorz/oas-generator/workflows/Java%20CI/badge.svg?branch=master[\"Java CI\",link=https://github.com/chhorz/oas-generator/actions?query=workflow%3A%22Java+CI%22]\nimage:https://img.shields.io/maven-central/v/com.github.chhorz/oas-generator.svg?logo=apachemaven\u0026label=Maven%20Central[\"Maven Central\", link=\"https://search.maven.org/artifact/com.github.chhorz/oas-generator\"]\n\n== About\nThe *OAS Generator* is a java annotation processor that generates an OpenAPI specification file from the java annotations within the source code.\nBecause the file is generated during compilation, the documentation is always up-to-date and references the current state of the implementation.\n\n* OpenAPI Specification 3.1.0 (link:https://spec.openapis.org/oas/v3.1.0[Link])\n\n== Getting Started\n. Add the corresponding dependency to your project\n+\n[source,xml]\n----\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.chhorz\u003c/groupId\u003e\n    \u003cartifactId\u003eoas-generator-{spring-web|jaxrs|schema|asciidoctor}\u003c/artifactId\u003e\n    \u003cversion\u003e${oas-generator.version}\u003c/version\u003e\n\u003c/dependency\u003e\n----\n. Create a configuration file `oas-generator.yml` (per default in _/src/main/resources_).\nAn example can be found in the link:https://chhorz.github.io/oas-generator/docs/current/reference/configuration.html#configuration-file[reference documentation].\n. Update the Javadoc comments to match the requirements\n\n== Documentation\n\nThe link:https://chhorz.github.io/oas-generator/[documentation] can be found on the separate GitHub Page.\nThe page also includes the link:https://chhorz.github.io/oas-generator/docs/current/releases.html[reference documentation] for all versions.\n\n\n== Snapshots\nSnapshots are available from the Sonatype OSS Snapshots repository.\nTo configure the repository for your project to use the latest snapshot versions you have to add the following repository to your maven pom:\n[source,xml]\n----\n\u003crepositories\u003e\n    \u003crepository\u003e\n        \u003cid\u003eossrh\u003c/id\u003e\n        \u003curl\u003ehttps://oss.sonatype.org/content/repositories/snapshots\u003c/url\u003e\n    \u003c/repository\u003e\n\u003c/repositories\u003e\n----\n\n== License\nOAS Generator is Open Source software released under the link:https://www.apache.org/licenses/LICENSE-2.0.txt[Apache 2.0 license].\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchhorz%2Foas-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchhorz%2Foas-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchhorz%2Foas-generator/lists"}