Executando verificação de segurança...
Em resposta a Documentação da API do TabNews
2
filipedeschamps

Sensacional Gabriel, meus sinceros parabéns pela contribuição!!!

Um detalhe importante para que seja economizado um redirect, é mudar a URL de:

https://tabnews.com.br

Para:

https://www.tabnews.com.br

Uma pergunta ao @filipedeschamps, onde essa documentação deve ser adicionada? No GitHub?

Eu queria fazer um teste adicionando no README do projeto, para que a pessoa que estiver lendo a porta de entrada principal repositório, já visse que temos uma API e ela é muito simples de usar, mas não sei exatamente como fazer para ficar legal.

Carregando publicação patrocinada...
2
MattFerreira

@GabrielSozinho, mano ficou TOP essa documentação.

@filipedeschamps Hj mais cedo eu abri a issue #555 justamente dando uma ideia sobre isso rsrs.

Nele eu comentei que a gente poderia implementar a documentação da API a partir de alguma lib que implementa Open API, estilo a Redoc que é usada no BrasilAPI (que particularmente eu gosto muito desse formato de doc).

Aí unindo um pouco com a sua ideia de testar add no README do projeto, a gente poderia criar um tópico dentro dele dando um overview da API junto com algumas explicações gerais, e logo abaixo a gente direciona para a pessoa visitar a página da doc completa.

2
1