{"id":51100360,"url":"https://github.com/arthur-s/docfinder","last_synced_at":"2026-06-24T10:00:55.116Z","repository":{"id":333630145,"uuid":"1137991854","full_name":"arthur-s/docfinder","owner":"arthur-s","description":"Fetch documentation for single endpoint from openapi file","archived":false,"fork":false,"pushed_at":"2026-01-20T09:29:18.000Z","size":23,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-01-20T15:59:39.386Z","etag":null,"topics":["cli","docs","openapi"],"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/arthur-s.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":"2026-01-20T05:27:30.000Z","updated_at":"2026-01-20T09:29:21.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/arthur-s/docfinder","commit_stats":null,"previous_names":["arthur-s/docfinder"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/arthur-s/docfinder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arthur-s%2Fdocfinder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arthur-s%2Fdocfinder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arthur-s%2Fdocfinder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arthur-s%2Fdocfinder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arthur-s","download_url":"https://codeload.github.com/arthur-s/docfinder/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arthur-s%2Fdocfinder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34724756,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-24T02:00:07.484Z","response_time":106,"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":["cli","docs","openapi"],"created_at":"2026-06-24T10:00:54.095Z","updated_at":"2026-06-24T10:00:55.106Z","avatar_url":"https://github.com/arthur-s.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DocFinder\n\nA CLI tool for extracting and formatting documentation for specific API endpoints from OpenAPI 3.x specification files.\n\n## Features\n\n- ✅ **Multi-method support**: Filter by HTTP method (GET, POST, PUT, DELETE, etc.)\n- ✅ **Short syntax**: `docfinder GET /books/{id} spec.yaml` (no flags needed!)\n- ✅ **Smart detection**: Case-insensitive, auto-recognizes HTTP methods\n- ✅ **Clear errors**: Shows available methods when invalid method specified\n- ✅ **Comprehensive output**: Schema details, validation constraints, examples\n\n## Installation\n\n```bash\ngo build -o docfinder cmd/docfinder/main.go\n```\n\n## Usage\n\n```bash\n# Show all methods\ndocfinder /books/{book_id} openapi.yaml\n\n# Filter by method (short syntax - recommended)\ndocfinder GET /books/{book_id} openapi.yaml\ndocfinder POST /books openapi.yaml\ndocfinder put /books/{book_id} openapi.yaml        # case-insensitive\n\n# Alternative: use -method flag\ndocfinder -method DELETE /books/{book_id} openapi.yaml\n\n# Generate docs to files\ndocfinder GET /books/{book_id} api.yaml \u003e docs/get-book.md\ndocfinder POST /books api.yaml \u003e docs/create-book.md\n\n# Batch processing\nfor method in GET POST PUT DELETE; do\n  docfinder $method /books/{book_id} api.yaml \u003e docs/${method,,}-book.md\ndone\n```\n\n## Command-Line Help\n\n```\nUsage:\n  docfinder [METHOD] \u003cendpoint-path\u003e \u003copenapi-file\u003e\n  docfinder -method METHOD \u003cendpoint-path\u003e \u003copenapi-file\u003e\n\nExamples:\n  docfinder /books/{book_id} openapi.yaml                    # All methods\n  docfinder GET /books/{book_id} openapi.yaml                # GET only\n  docfinder -method DELETE /books/{book_id} openapi.yaml     # Flag syntax\n\nArguments:\n  METHOD          Optional HTTP method (GET, POST, PUT, DELETE, PATCH, etc.)\n  endpoint-path   API endpoint path to extract documentation for\n  openapi-file    Path to OpenAPI YAML specification file\n\nFlags:\n  -method string  HTTP method to filter. If not specified, shows all methods.\n```\n\n## Output Format\n\nGenerated markdown includes:\n- API metadata (title, version, base URLs)\n- HTTP method and endpoint path\n- Operation summary, description, and tags\n- Parameters (path, query, header) with types and constraints\n- Request/response body schemas with examples\n- Security requirements\n- Deprecation warnings\n\n## Testing\n\n```bash\ngo test ./...\n```\n\n## Contributing\n\nContributions welcome! Please ensure:\n- All tests pass (`go test ./...`)\n- Code is formatted with `gofmt`\n- New features include tests\n- Documentation is updated\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farthur-s%2Fdocfinder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farthur-s%2Fdocfinder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farthur-s%2Fdocfinder/lists"}