Veja como criar uma documentação para APIs com Swagger e OpenAPI
Para que uma API tenha sucesso no mercado e seja muito utilizada, ela precisa ter uma boa documentação, que forneça ao usuário o que ele precisa para prosseguir com o seu desenvolvimento de software. Mas, pode ser difícil criada uma