Comments (9)
Achei bem interessante esse API Blueprint. Tirei uns minutos aqui pra testar como ficaria a implementação da documentação da API do CEP. Por enquanto só consegui visualizar usando o Apiary, que infelizmente é pago quando se trabalha com times. Existe algum lugar onde eu possa dar upload que facilite o desenvolvimento sem custar nada?
EDIT: Que não seja o GitHub, já que a ideia por trás da Blueprint é visualizar utilizando o feature de Markdown de um lado e Visualização da API do outro.
Eu gosto bastante do Blueprint, na aba de Tools há diversos renders e recomendo o Aglio, inclusive é possível levantar um mock direto da documentação com o Drakov além de testes automatizados utilizando a especificação dela com o Dredd, também é possível converter para outras especificações como o Swagger.
from brasilapi.
Acho interessante criar um repositório na organização para focar na documentação, podemos usar até o github pages para isso, porque algo comum na comunidade open source, a galera até buscar por um brasilapi.github.io
from brasilapi.
O PR #171 já foi merged e criava a documentação: https://brasilapi.com.br/docs
Vou fechar essa issue.
@CarlosZiegler obrigado pela contribuição!
from brasilapi.
Achei bem interessante esse API Blueprint. Tirei uns minutos aqui pra testar como ficaria a implementação da documentação da API do CEP. Por enquanto só consegui visualizar usando o Apiary, que infelizmente é pago quando se trabalha com times. Existe algum lugar onde eu possa dar upload que facilite o desenvolvimento sem custar nada?
EDIT: Que não seja o GitHub, já que a ideia por trás da Blueprint é visualizar utilizando o feature de Markdown de um lado e Visualização da API do outro.
from brasilapi.
Eu vi sobre o Swagger, mas nao encontrei material sobre implementar ele no Next.Js apenas no Express.
from brasilapi.
Show!!!!!
from brasilapi.
É super importante ter uma documentação legal. É o que vai fazer com que as pessoas usem com mais facilidade a API. @filipedeschamps Já tem alguma ideia de qual soluçao de documentação que vai usar?
from brasilapi.
Já mexi com o API Blueprint + Aglio, poderia ajudar nisso.
Exemplo da API Blueprint hosteada na Apiary: https://gamer1.docs.apiary.io/#reference/games/plataforms/criar-plataforma
Exemplo de projeto com API Blueprint + Apiary: https://github.com/allangrds/pagarme-payment-service-provider/tree/master/docs/src
Acredito que facilita deixar tudo por aqui. Acham que vale um repo novo ao invés de deixar aqui?
from brasilapi.
from brasilapi.
Related Issues (20)
- API CNPJ - Email Response HOT 4
- Campo CNPJ diferente da documentação HOT 1
- Cep incorreto quando consultado na api HOT 1
- API de consulta de veículos por placa HOT 3
- Endpoint CNPJ fora do ar HOT 4
- API Consulta Cnpj HOT 2
- Testes quebrando no ncm.
- Alguns CEPs retornando 404 HOT 13
- Alguns CEPs só são encontrados com hífen. Outros só são encontrados sem hífen HOT 2
- CEP V2 - Não encontra geolocalização HOT 10
- Possible error with Cache-Control caching HOT 5
- Consulta CEP V2 - possível problema na comunicação com serviços HOT 4
- Hoje está dando erro parra qquer CEP HOT 7
- Busca de cidades por UF traz 0 resultados para a sigla AP - Amapá HOT 2
- CEPs V1 - Erro - strict-origin-when-cross-origin HOT 1
- Erro ao consultar CNPJ HOT 9
- Erro em todos serviços de consulta de CEP (https://brasilapi.com.br/api/cep/v2/38408224) HOT 1
- Erro ao consultar CEP Api V2, para qualquer endereço HOT 16
- API CNPJ retornando 404 para qualquer CNPJ HOT 4
- Erro ao consultar CEP Api V1, para qualquer endereço HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from brasilapi.