Git Product home page Git Product logo

geonames-api's Introduction

GeoNames API Example

Build Status

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 mapeados no arquivo token-config.php localizado na pasta data.

A documentação dos endpoints deve ser lida e pode ser encontrada na pasta doc. Ela é feita utilizando a notação do ApiBluePrint e é gerada utilizando o Aglio. Também existe a documentação convertida para OpenAPI v3.

Executando o projeto

  1. Copie ou renomeie o arquivo config/autoload/doctrine-mongo-odm.local.php.dist
  2. Execute docker-compose up
  3. Em seguida execute docker exec -it geonames_apigility composer install
  4. Faça os testes via Postman ou similar no endereço 0.0.0.0:8080/cities
  5. Caso não tenha o docker é necessário verificar as dependências do projeto e ajustar as configurações do mongo no arquivo acima

EXTRA - Instalação Aglio

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

geonames-api's People

Contributors

mariojrrc avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.