Software Público Brasileiro

Milestone changed to [backend] Planejamento de refatoração e incorporação ao master do noosfero

Milestone changed to [backend] Diagnóstico dos braches atuais do Serpro

Milestone changed to [backend] Criar documentação de apoio aos clientes da API Noosfero

issues relacionadas: #27 e #28

@kanashiro você conseguiu andar com isto aqui?

@joenio @mfdeveloper tinha começado a documentação. Vocês estão continuando a que ele começou? Acho que foi com o grape swagger. https://github.com/ruby-grape/grape-swagger

eu acho que parte disso já existe no http://localhost:3000/api o que seria preciso é evoluir isso

@joenio ainda não consegui começar essa task

É possível consultar e testar os endpoints da API a partir do seguinte endereço:

• https://softwarepublico.gov.br/social/api/playground

Documentar na Wiki noosferogov e enviar para @ricardopoppi que irá divulgar no MJ.

@joenio Conforme @evandrojr e @leandronunes já estávamos utilizando aqui a integração com Swagger para documentar a API, e comunicar novos endpoints para a equipe de frontend. Isso não será mais utilizado?

@mfdeveloper enquanto o @joenio responde, queria acrescentar o que debatemos na ultima retrospectiva de sprint sobre isso:

1) é fundamental a integração com o Swagger para a documentação ser sustentável, "auto-atualizável"
2) para o caso concreto das duas integrações que faremos com o sistema de participação do MJ, ficou a cargo do Lappis nessa sprint fazer uma documentação de uso da API para acessar as informações do fórum de discussão estruturada do noosfero (que é utilizado no dialoga brasil) e a API do pairwise, via noosfero

o que acha?

Assignee removed

Reassigned to @darksshades

@joenio @darksshades podem indicar aqui qual a página wiki onde essa documentação será feita? valeu!

@ricardopoppi @joenio Aqui estão as informações básicas sobre a utilização da API https://softwarepublico.gov.br/gitlab/noosferogov/noosfero/wikis/noosfero-api

Vou colocar ainda sobre a utilização e alguns exemplos de endpoints especificos como de comunidade, artigos, etc. Mas dai eu crio o link através desta página acima.

obrigado @darksshades seguimos acompanhando 😉

legal @darksshades, ficou bom!!!

Não esquece de documenta o caso concreto sugerido por @ricardopoppi:

2) para o caso concreto das duas integrações que faremos com o sistema de participação do MJ, ficou a cargo do Lappis nessa sprint fazer uma documentação de uso da API para acessar as informações do fórum de discussão estruturada do noosfero (que é utilizado no dialoga brasil) e a API do pairwise, via noosfero

Lembrando que o caso do pairwise iremos desconsiderar por hora, vamos focar no fórum de discussão.

https://softwarepublico.gov.br/gitlab/noosferogov/noosfero/wikis/noosfero-api

Documentação e Exemplo de caso de uso.

Status changed to closed

https://softwarepublico.gov.br/gitlab/noosferogov/noosfero/wikis/noosfero-api

Documentação e Exemplo de caso de uso.

valeu @darksshades!!! @ricardopoppi passa pros caras o caso de uso:

• https://softwarepublico.gov.br/gitlab/noosferogov/noosfero/wikis/api-use-case