- Notifications
You must be signed in to change notification settings - Fork0
License
NotificationsYou must be signed in to change notification settings
mariojrrc/geonames-api
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Este projeto contém uma API REST de exemplo escrita em PHP utilizando Zend Apigility e Mongo DB.Possui basicamente dois endpoints com CRUD:
- /cities
- /states
Para acessar a api é necessário ter tokens mapeadosno arquivo token-config.php localizado na pastadata.
A documentação dos endpoints deve ser lida e pode ser encontrada na pastadoc. Ela é feita utilizandoa notação do ApiBluePrint e é gerada utilizando o Aglio. Também existe a documentação convertida para OpenAPI v3.
- Copie ou renomeie o arquivo
config/autoload/doctrine-mongo-odm.local.php.dist - Execute
docker-compose up - Em seguida execute
docker exec -it geonames_apigility composer install - Faça os testes viaPostman ou similar no endereço
0.0.0.0:8080/cities - Caso não tenha o docker é necessário verificar as dependências do projeto e ajustar as configurações do mongo no arquivo acima
Instale globalmente via NPM. É necessário ter o Node.js instalado.
npm install -g aglio aglio-theme-olio
Depois, gere o HTML com layout do Olio.
aglio -i doc/geonames.apib -o doc/geonames.html