goal is to make it very easy for app developers to make GoToSocial applications, by very clearly documenting the API in a structured way
one cool thing about swagger: if you have a good swagger specification, you can automatically generate clients that can interface with that specification
so generating a client that can interact with gotosocial could be done automatically for a variety of languages
Follow
fuchsiaaaaaaaaaaaaaaaaa
@dumpsterqueer hmm swagger is nice for when you just need info on some specific routes, but generally I prefer full documentation (with route documentation) like the new https://spec.matrix.org because it provides a lot more space for rationale/extra explanations. In practice I use both for Matrix things (they have Swagger too)
@f0x that makes sense! my current thinking is to have an API section in the docs that includes both general design discussion and gotchas for the API, and maybe some 'get started with the API' guide, as well as (if possible) integrated swagger docs
so basically: both