{"id":18272493,"url":"https://github.com/alpdr/gindocnic","last_synced_at":"2026-04-14T00:04:40.593Z","repository":{"id":261169851,"uuid":"883465819","full_name":"alpdr/gindocnic","owner":"alpdr","description":"An OpenAPI 3.1 specification generator for Gin Web Framework","archived":false,"fork":false,"pushed_at":"2025-03-14T15:30:55.000Z","size":76,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-14T16:34:05.193Z","etag":null,"topics":["gin","gin-gonic","go","golang","openapi","openapi-specification","openapi3"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alpdr.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}},"created_at":"2024-11-05T02:27:43.000Z","updated_at":"2025-03-14T15:30:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"88d42b96-0cd3-45c1-9022-752dab0712e9","html_url":"https://github.com/alpdr/gindocnic","commit_stats":null,"previous_names":["alpdr/gindocnic"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpdr%2Fgindocnic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpdr%2Fgindocnic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpdr%2Fgindocnic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpdr%2Fgindocnic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alpdr","download_url":"https://codeload.github.com/alpdr/gindocnic/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247970707,"owners_count":21026192,"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":["gin","gin-gonic","go","golang","openapi","openapi-specification","openapi3"],"created_at":"2024-11-05T12:02:22.456Z","updated_at":"2026-04-14T00:04:40.556Z","avatar_url":"https://github.com/alpdr.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gindocnic\n\u003c!--[golang-standards/project-layout](https://github.com/golang-standards/project-layout) suggested Go Report Card, Go Reference, and release badges\" --\u003e\n[![Go Report Card](https://goreportcard.com/badge/github.com/alpdr/gindocnic)](https://goreportcard.com/report/github.com/alpdr/gindocnic)\n[![Go Reference](https://pkg.go.dev/badge/github.com/alpdr/gindocnic.svg)](https://pkg.go.dev/github.com/alpdr/gindocnic)\n[![release](https://img.shields.io/github/v/release/alpdr/gindocnic.svg?style=flat-square)](https://github.com/alpdr/gindocnic/releases)\n\nA library for generating OpenAPI 3.1 documentation for the Gin Web Framework.\n\n## Usage\nA basic example:\n```go\ndoc := NewDoc()\nr := gin.Default()\n\nrequest := struct {\n    Id int `json:\"id\" binding:\"required\"`\n}{}\nspec := func(p *PathItemSpec) {\n    p.AddRequest(request)\n}\nr.POST(\"/pets\", doc.Operation(func(c *gin.Context) {}, spec))\nif err := doc.AssocRoutesInfo(r.Routes()); err != nil {\n    log.Fatalf(\"%#v\", err)\n}\nyml, err := doc.MarshalYAML()\nif err != nil {\n    log.Fatalf(\"%#v\", err)\n}\nfmt.Println(string(yml))\n```\n\nOutput:\n```\nopenapi: 3.1.0\ninfo:\n  title: \"\"\n  version: \"\"\npaths:\n  /pets:\n    post:\n      operationId: pets0\n      requestBody:\n        content:\n          application/json:\n            schema:\n              properties:\n                id:\n                  type: integer\n              required:\n              - id\n              type: object\n      responses:\n        \"204\":\n          description: No Content\n      summary: \"\"\n```\n\nFurther examples are available in the [API documentation on go.dev](https://pkg.go.dev/github.com/alpdr/gindocnic).\n\n## Contributing\n- The layout of this module loosely follows [a basic layout for Go application projects](https://github.com/golang-standards/project-layout).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falpdr%2Fgindocnic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falpdr%2Fgindocnic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falpdr%2Fgindocnic/lists"}