Hola. I have 30 + APIs i need to document.

Question

Hola. I have 30 + APIs i need to document.

we have it on swagger already. but we want to extra deatils. do you guys know any tools that? it should be documented on confluence but it's not a must.

0

31.08.2023

3 ответов

20 просмотров

Dan A Автор вопроса

looks good, but sketchy cause i need to give it our confluence creds.

0

04.09.2023

Sebastian

Dan A
looks good, but sketchy cause i need to give it ou...

do you know an method for writing on confluence without credentials? And it does not need use be credentials of an person, you can create an account that has only the minimal requirements for this. An ci process can then use these credentials to update the docs automatically.

0

04.09.2023

Sebastian · Accepted Answer

Sebastian

i think there are sphinx plugins for swagger/openapi and confluence. It uses the yml fron swagger, converts it to the internal representation, you can add additional details with restructured text/markdown and sphinx-build -b confluence deploys it to comfluence. in my company multiple circumstances hindered me from using this combination, so i can't say exactly how well this combination works.

0

31.08.2023

Похожие чаты

Hola. I have 30 + APIs i need to document.

3 ответов

Похожие вопросы