Our great sponsors
-
-
InfluxDB
Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
This is the fastest way; it isn't necessarily the best for an API, because godoc is designed to document Go code, not HTTP APIs. You can use something like go-swagger to try to generate swagger/OpenAPI documentation. However, I find it a useful package, but a frustrating one to use. It likes to silently fail and just stop generating documentation and imposes a couple of restrictions the underlying spec doesn't. I find I have to make one change at a time and run their generator after each one, because at any moment, I may make a small typo, or confuse it some other way, and lose entire chunks of my documentation silently. But when it is working, it is an option for documenting APIs.