O Bankly Open API Schemas é fortemente baseado no OpenAPI Specification 3* (OAS). Nossas APIs buscam aplicar a melhor interpretação da arquitetura REST.
$ git clone https://github.com/acesso-bankly/open-api.git && cd ./open-api
$ npm install && npm start
Crie uma branch com um dos prefixos: feature/ , enhancement/ ou fix/
Ex:
- feature/adiciona-idempotency-header
- enhancement/descricao-api-version
- fix/descricao-api-version
Utilizando o Swagger Editor, é possível ver a renderização do arquivo (Open Api) no momento da alteração.
Para utilizá-lo, dentro da pasta dos arquivos, abra um prompt de comando e digite: npm run edit:{api}. No browser, a página do editor abrirá no endereço http://127.0.0.1:{porta}/?url=/oas/spec
Após fazer as atualizações, commit as mudanças e submeta um Pull Request apontando para a branch develop.
🗒️ DICA! Faça commits pequenos e centrados na alteração que está propondo.
Ajude-nos a manter nossa documentação atualizada, caso tenha comentários e sugestões, envie seu Pull Request!
Beta:
<span class="bkly-ref-small-beta-tag">beta</span>A tag beta define que o endpoint da API está em aprimoramento e poderá sofrer alterações que gerem breaking changes.
Stable:
<span class="bkly-ref-small-stable-tag">stable</span>A tag stable define que o endpoint da API é estável e não sofrerá alterações que geram breaking changes.
Deprecated:
<span class="bkly-ref-small-deprecated-tag">deprecated</span>A tag deprecated define que o endpoint da API está obsoleto e foi substituído por outro.
Scope
<span class="bkly-ref-scope-tag">scope: {{scope}}/span>A tag scope define qual é o scope requerido no token para acessar a API.
O Bankly faz forte uso do sistema de versão semântico. No entanto, na API Pública, somente exibimos e requeremos que seja informado o major da API, através do header api-version.