{"id":35124266,"url":"https://github.com/mikros-dev/protoc-gen-mikros-openapi","last_synced_at":"2026-02-05T19:02:38.171Z","repository":{"id":280009300,"uuid":"878647078","full_name":"mikros-dev/protoc-gen-mikros-openapi","owner":"mikros-dev","description":"A protoc/buf OpenAPI plugin to work together with mikros","archived":false,"fork":false,"pushed_at":"2026-01-28T21:34:54.000Z","size":137,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-29T12:12:34.346Z","etag":null,"topics":["buf","openapi","plugin","protobuf","protoc"],"latest_commit_sha":null,"homepage":"","language":"Go","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/mikros-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2024-10-25T19:27:54.000Z","updated_at":"2026-01-28T21:34:23.000Z","dependencies_parsed_at":"2025-05-13T15:35:28.798Z","dependency_job_id":"3bc4a8ce-2141-4a79-9379-83ac9e8d3c1a","html_url":"https://github.com/mikros-dev/protoc-gen-mikros-openapi","commit_stats":null,"previous_names":["mikros-dev/protoc-gen-openapi","mikros-dev/protoc-gen-mikros-openapi"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/mikros-dev/protoc-gen-mikros-openapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikros-dev%2Fprotoc-gen-mikros-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikros-dev%2Fprotoc-gen-mikros-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikros-dev%2Fprotoc-gen-mikros-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikros-dev%2Fprotoc-gen-mikros-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mikros-dev","download_url":"https://codeload.github.com/mikros-dev/protoc-gen-mikros-openapi/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikros-dev%2Fprotoc-gen-mikros-openapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29130113,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-05T18:55:47.139Z","status":"ssl_error","status_checked_at":"2026-02-05T18:55:04.010Z","response_time":65,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["buf","openapi","plugin","protobuf","protoc"],"created_at":"2025-12-28T01:37:41.800Z","updated_at":"2026-02-05T19:02:38.165Z","avatar_url":"https://github.com/mikros-dev.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# protoc-gen-openapi\n\nA protoc/buf plugin to generate compatible [OpenAPI version 3.0.0](https://swagger.io/specification/v3/)\nYAML files from protobuf HTTP API declarations.\n\n## Features\n\nThis plugin provides an easy way of generating OpeAPI specification of an HTTP\nservice API directly from its protobuf file. It uses protobuf annotation options\nto allow the user define details about the service and its endpoints.\n\nIt can be used alone or together with the [protoc-gen-mikros-extensions](https://github.com/mikros-dev/protoc-gen-mikros-extension)\nplugin for messages and field names.\n\n## Installation and usage into projects\n\nTo install the plugin latest version and use it in your projects, use the command:\n```bash\ngo install github.com/mikros-dev/protoc-gen-mikros-openapi@latest\n```\n\nAssuming that a project is using [buf](https://buf.build/docs/) tool to compile\nand manage protobuf files, this plugin can be used the following way:\n\n\u003e Note: We assume buf version 2 here, if you're using version 1, use buf docs\n\u003e to check how to set a local plugin (or to migrate your settings to version 2).\n\n* Edit your **buf.gen.yaml** file, in the `plugins` section and add the following\n  excerpt:\n```yaml\nplugins:\n  - local: protoc-gen-mikros-openapi\n    out: gen # Where your generated files will be\n    opt:\n      - settings=extensions_settings.toml # The file name of your plugin settings\n```\n\n* Edit the **buf.yaml** file, in the `deps` section, add the following excerpt:\n```yaml\ndeps:\n  - buf.build/mikros-dev/protoc-gen-mikros-openapi\n```\n\n* Execute the command:\n```bash\nbuf dep update\n```\n\n## Building and installing locally\n\nIn order to compile and install the plugin locally you'll need to follow the steps:\n\n* Install the go compiler;\n* Execute the commands:\n    * `go generate`\n    * `go build \u0026\u0026 go install`\n\n## Protobuf extensions available\n\nThe following links present details about available options to be used from a\nprotobuf file.\n\n* [File](docs/file.md)\n* [Service](docs/service.md)\n* [Method](docs/method.md)\n* [Message](docs/message.md)\n* [Field](docs/field.md)\n\nFor more details or a complete example, use the [examples](examples) directory.\n\n## License\n\n[Apache License 2.0](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikros-dev%2Fprotoc-gen-mikros-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikros-dev%2Fprotoc-gen-mikros-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikros-dev%2Fprotoc-gen-mikros-openapi/lists"}