{"id":16885113,"url":"https://github.com/ericchiang/gopkgapi","last_synced_at":"2026-07-01T00:31:35.418Z","repository":{"id":145910007,"uuid":"96740617","full_name":"ericchiang/gopkgapi","owner":"ericchiang","description":"API documents for Go packages","archived":false,"fork":false,"pushed_at":"2017-07-10T06:16:16.000Z","size":64,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-20T05:45:16.010Z","etag":null,"topics":[],"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/ericchiang.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":"2017-07-10T05:53:57.000Z","updated_at":"2017-07-24T13:03:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"6cde8e8a-5433-43bf-97e8-08d197901c09","html_url":"https://github.com/ericchiang/gopkgapi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ericchiang/gopkgapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericchiang%2Fgopkgapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericchiang%2Fgopkgapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericchiang%2Fgopkgapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericchiang%2Fgopkgapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ericchiang","download_url":"https://codeload.github.com/ericchiang/gopkgapi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericchiang%2Fgopkgapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34988712,"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-30T02:00:05.919Z","response_time":92,"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":[],"created_at":"2024-10-13T16:33:25.059Z","updated_at":"2026-07-01T00:31:35.390Z","avatar_url":"https://github.com/ericchiang.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gopkgapi\n\n## Record your Go package's public API\n\n`gopkgapi` is a command line tool for generating API descriptions for a package or set of packages. The tool is inspired by Go's internal checker for ensuring the [Go 1 compatibility promise](https://golang.org/doc/go1compat) across the standard library. It spits out a similar format as the [Go API documents](https://github.com/golang/go/tree/master/api), one \"feature\" per line describing all exported types. \n\nThe tool aims to allow other projects to check-in similar documents, and record exactly when package API are added, removed, or changed.\n\nDownload using `go get`.\n\n```\ngo get github.com/ericchiang/gopkgapi\n```\n\nThen use the tool on any package or set of packages in your GOPATH or GOROOT.\n\n```\n$ gopkgapi net/http/httptest\npkg net/http/httptest, const DefaultRemoteAddr string\npkg net/http/httptest, func NewRecorder() *ResponseRecorder\npkg net/http/httptest, func NewRequest(string, string, io.Reader) *net/http.Request\npkg net/http/httptest, func NewServer(net/http.Handler) *Server\npkg net/http/httptest, func NewTLSServer(net/http.Handler) *Server\npkg net/http/httptest, func NewUnstartedServer(net/http.Handler) *Server\npkg net/http/httptest, method (*ResponseRecorder) Flush()\npkg net/http/httptest, method (*ResponseRecorder) Header() net/http.Header\npkg net/http/httptest, method (*ResponseRecorder) Result() *net/http.Response\npkg net/http/httptest, method (*ResponseRecorder) Write([]byte) (int, error)\npkg net/http/httptest, method (*ResponseRecorder) WriteHeader(int)\npkg net/http/httptest, method (*ResponseRecorder) WriteString(string) (int, error)\npkg net/http/httptest, method (*Server) Close()\npkg net/http/httptest, method (*Server) CloseClientConnections()\npkg net/http/httptest, method (*Server) Start()\npkg net/http/httptest, method (*Server) StartTLS()\npkg net/http/httptest, type ResponseRecorder struct\npkg net/http/httptest, type ResponseRecorder struct, Body *bytes.Buffer\npkg net/http/httptest, type ResponseRecorder struct, Code int\npkg net/http/httptest, type ResponseRecorder struct, Flushed bool\npkg net/http/httptest, type ResponseRecorder struct, HeaderMap net/http.Header\npkg net/http/httptest, type Server struct\npkg net/http/httptest, type Server struct, Config *net/http.Server\npkg net/http/httptest, type Server struct, Listener net.Listener\npkg net/http/httptest, type Server struct, TLS *crypto/tls.Config\npkg net/http/httptest, type Server struct, URL string\n```\n\nThere are small differences from Go's `api/` directory format:\n\n* Imports of types are represented by absolute path. For example, `*net/http.Request` instead of `*http.Request`.\n* Constants display their type, not their value.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fericchiang%2Fgopkgapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fericchiang%2Fgopkgapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fericchiang%2Fgopkgapi/lists"}