mastodon.social is one of the many independent Mastodon servers you can use to participate in the fediverse.
The original server operated by the Mastodon gGmbH non-profit

Administered by:

Server stats:

376K
active users

People who design APIs. I am begging you. It doesn't matter how "simple" or "intuitive" or "elegant" your API is. You need to include sample code.

Michael Cook

@mcc Always struggling with this.

“Is there documentation?”

“Here’s the list of endpoints.”

“So no?”

@foobarsoft @mcc "says /documentation/ right there in the Swagger UI URL"

@clacke @mcc @foobarsoft I've always preferred swagger interfaces if they are done well

@bassplayer They can be done well, with excellent examples and guidance and all, but they can also be just a list of endpoints, and depending on the backend the spec may or may not match the implementation.

@mcc @foobarsoft

@bassplayer In principle I agree with you, and I think a form of executable documentation is the best documentation. An excellent Swagger UI is a great troubleshooting and teaching tool.

But there's no guarantee, and it's easy to say "documentation? oh yeah we have a swagger", which may be glorious or it may mean almost nothing.

@mcc @foobarsoft