Importar um documento API Blueprint
O API Blueprint descreve uma API em Markdown enriquecido. O Restorm analisa-o com o parser oficial (Drafter), compilado em WebAssembly e integrado: não é necessária nenhuma ferramenta externa.
Importar
Section titled “Importar”Ficheiro ▸ Importar (Ctrl+I) e depois o ficheiro .apib, ou conteúdo
colado que comece por FORMAT: 1A.
O que é importado
Section titled “O que é importado”| Elemento | O que o Restorm faz com ele |
|---|---|
| Os grupos de recursos | Pastas |
| Cada transição | Um pedido HTTP |
| Os parâmetros | Tipados |
| O URL do servidor | O URL de base do ambiente |
| Descrições e modelos | A documentação de API |
Vários exemplos por transição
Section titled “Vários exemplos por transição”Uma transição API Blueprint pode declarar vários pares
+ Request / + Response. O Restorm cria um pedido por par, com um sufixo
de índice (#1, #2…) para os distinguir.