https://github.com/andymccall/api.postcode.software

REST Query for UK postcodes over HTTP and HTTPS
https://github.com/andymccall/api.postcode.software

java microservice mongodb postcode postcode-validation rest-api spring spring-boot

Last synced: 4 months ago
JSON representation

REST Query for UK postcodes over HTTP and HTTPS

• Host: GitHub
• URL: https://github.com/andymccall/api.postcode.software
• Owner: andymccall
• Created: 2017-01-19T22:23:23.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-02-14T21:16:11.000Z (over 8 years ago)
• Last Synced: 2024-12-30T22:41:31.258Z (6 months ago)
• Topics: java, microservice, mongodb, postcode, postcode-validation, rest-api, spring, spring-boot
• Language: Java
• Homepage:
• Size: 5.42 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Postcode.software

Query for UK postcodes over HTTP and HTTPS. Postcode.software uses the Post Office sample PAF file.

Documentation for the API can be found at [Swagger](https://app.swaggerhub.com/api/andymccall/api.postcode.software/1.0.0).

### Build Status and Test Coverage

[![Build Status](https://travis-ci.org/andymccall/api.postcode.software.svg?branch=master)](https://travis-ci.org/andymccall/api.postcode.software)

[![Coverage Status](https://coveralls.io/repos/github/andymccall/api.postcode.software/badge.svg?branch=master)](https://coveralls.io/github/andymccall/api.postcode.software?branch=master)

A demo of this service can be found at:

  [http://api.postcode.software/](http://api.postcode.software/)

& [https://api.postcode.software/](https://api.postcode.software/)

  

 Currently working API endpoints are:

 

    * ping

    * postcode/

    * postcode//

    * validate/

    * validate//

    * random

    * random/

    * udprn/

 

 The service uses the sample PAF file from the Post Office which does not have all addresses in it, to test use /random or /random/\ to return valid postcodes.