Documentar una API (GOG Galaxy)

Hola Gente

He hecho un poco de ingeniería inversa sobre una API (la de galaxy de gog) y la estoy usando para mis propósitos.

Ya existe alguna documentación sobre la API, pero esta abandonada y no incluye la parte de descarga de juegos por ficheros individuales, que es la parte de la que tengo la ingeniería inversa hecha.

¿Cual sería el mejor sitio y manera de publicar una documentación de esto para que desde proyectos como Lutris puedan usarla si quieren?

Nunca he documentado una API la verdad y no se para donde tirar.
Que tipo de api exactamente, restful? El más usado es swagger, si quieres algo más genérico (documentación de proyectos) tienes entre otros
https://www.sphinx-doc.org/en/master/
https://readthedocs.org/

Estos te lee la documentación del mismo código para generar un html final que puedes subir a cualquier server.
Es una API Rest, perdona que no especifique

De hecho ahora que dices lo de readthedocs, estoy viendo que la docuemtnación antigua esta ahí, lo he seguido hasta el github que contiene el codigo, y quizas simplemente actualice la documentación con las partes que faltan de la API.

Muchas gracias!
Openapi / swagger es lo que estas buscando
3 respuestas