Generating a better GoDoc for API library
I implemented a typical REST API library in Go. But due to the amount of endpoints and different data structures of which almost none are shared between endpoints the GoDoc for the project is very confusing:
The way it is structured right now makes it hard to see what is returned by the actual functions and requires a lot of scrolling through the document to find the associated structures with the data.
The Endpoints are all part of the API struct as they can share the authentication state between calls to the API, which causes them all to be listed below the GW2Api struct instead of their associated data structures.
Is there a good way to make the library API clearer with GoDoc, aside from adding comments to function calls?
One example of an api package that I think does pretty well is the github wrapper: https://godoc.org/github.com/google/go-github/github.
If you have a large api, a bit of a large godoc is somewhat unavoidable. Note that rather than have a million methods defined directly off of client, the core object has multiple "service" objects defined, which allow them to partition the methods into logical groups. I could see multiple possible groups from the methods in your api.
I don't think there is a super good way to group methods with the struct types they act on or return without significant changes to your api. Rather expect people to look for the operations they want to perform, and from there link to the specific struct types for reference.
- Execute multiple switch cases
- Go - How to test a siphash 2-4 function with known vectors
- Does go trim out unreferenced packages when building a final binary, and if so, why do they still show in inspecting builds?
- large number of heap allocations in database query results
- How to escape the html using golang?
- Prevent missing fields in struct initialization
- Use private go module with gitlab ci Auto-DevOps for auto test
- golang; List inside of a map; <nil> after the last element
- Generating a better GoDoc for API library
- How write a Go program that behaves same as openssl rehash?
- HTMX and GO, can't send data with GET Request from HTML Table
- golang gin when to use handleContext and when redirect
- Convert interface argument from any type available
- How can I elliptically truncate text in golang?
- Why would you use fmt.Sprint?
- Go Endpoint doesn't call handler Method
- Converting logs to JSON format
- What is the use of <-ctx.Done() in select statments?
- Generics for methods
- Get terminal size in Go
- How can I launch several goroutines and obtain the result of each one separately?
- How to convert from []byte to int in Go Programming
- When does the init() function run?
- Unsupported relations in gorm
- How to Test TLSv1 Connection for Python Requests to GoLang TLSv1 HTTPS Server
- Converting parquet file to Golang struct with nested elements
- go module @latest found but does not contain package
- How to disable HTTP/2 using Server.TLSNextProto
- Problem to connect container golang with container mysql
- Reading first byte from a stream in Golang