Find a Legal Adviser API

Problem description

This provide a RESTful API to find a legal aid adviser . This is one hour work (took little more) and not production ready

Assumptions

• It is a public API for demo only
  
• No authorisation and authentication
  
• This should be completed in an hour
  • Paging not added
  • No caching at the API(RESTFUl) level. Although the data is cached at the java end
  • Minimal validation
  • No API documentation is used (like swaggar)

Compatibility

JDK/JRE

The App has been compiled by a more recent version of the Java Runtime (class file version 55.0). JDK 12 is used for the project

Gradle

• The built is with Gradle . The version used is 4.10.2
• It can be built from Java
• The IntelliJ is used as IDE

Source Code

C:. ├───main │ ├───java │ │ └───uk │ │ └───gov │ │ └───justice │ │ └───digital │ │ └───legaladviser │ │ ├───domain │ │ ├───exception │ │ ├───persistence │ │ ├───resources │ │ └───service │ └───resources └───test └───java └───uk └───gov └───justice └───digital └───legaladviser └───test

Build the jar

Gradle

A gradle task is configure in build.gradle To build using gradle

gradlew bootJar

Running

The legal-providers.csv is added as a resource. So you can run either through gradle or throug java

gradlew bootRun
Alternatively this can be run
java -jar moj-excercise-legal-providers.jar

The ability to pass files as argument will not give any error. But this is not completely implemented as on now due to time restrictions. So the csv file name is loaded as a resource

gradlew bootRun --args='--db=legal-providers.csv'
Alternatively this can be run
java -jar moj-excercise-legal-providers.jar --db=legal-providers.csv

Notes

• Gradle buildscan is configured to report any build or run issues

Executing APIs

Filter legal legaladvisers based on condition

The following are possible

crime,debt,housing,immigrationorasylum,welfarebenefits

Examples

List of APIs

http://localhost:8080/

Find by ID

http://localhost:8080/legaladviser/1

Find all

http://localhost:8080/legaladvisers

Filer based on condition

Method 1, each wih categories spec

1. http://localhost:8080/legaladvisers?categories=crime&categories=bebt

Method 2, coma delimited

2. http://localhost:8080/legaladvisers?categories=CriMe,Debt
3. http://localhost:8080/legaladvisers?categories=crime,debt,immigrationorasylum,immigrationorasylum
4. http://localhost:8080/legaladvisers?categories=crime,debt,housing,immigrationorasylum,welfarebenefits