Giter Club home page Giter Club logo

companieshouse.poc-appointments-api's Introduction

poc-appointments-api

PoC for the potential new Appointments API

The service is a spring-boot application with a RESTful interface. It queries the appointments collection persisted in the CHS MongoDB database collection and returns any results through the REST API

Requirements

In order to run this service you need:

  • A Mongodb instance running a database called appointments
  • A collection within it called appointments
  • Configure spring.data.mongodb.uri in application.properties to point to specific database

Start appointments API

mvn package && java -jar target/poc-appointment-api-0.0.1-SNAPSHOT.jar

or

mvn spring-boot:run

or

run PocAppointmentApiApplication.java from within an IDE

End points

/company/{companyNumber}/appointment/{appointmentId}

/healthcheck

Example Calls

Use Postman

Running locally:

localhost:8080/healthcheck

localhost:8080/company/00006400/appointment/VZBT2w_EIi3Fx3QFr1xpRPG3oFA

or

curl http://localhost:8080/company/00006400/appointment/VZBT2w_EIi3Fx3QFr1xpRPG3oFA

companieshouse.poc-appointments-api's People

Contributors

dlloyd1-ch avatar drosser 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.