Service Layer

Service Layer

Table of Contents

• Service Layer
  • Table of Contents
  • Setup
    • Prerequisites
  • Configuration
  • Usage
    • Testing
  • OpenAPI Specifications
  • API Request Collection
  • Contacts
  • Licence

Setup

TODO

Clone the repository

git clone https://github.com/NHSDigital/dtos-service-layer
cd dtos-service-layer

Prerequisites

The following software packages, or their equivalents, are expected to be installed and configured:

• Docker container runtime or a compatible tool, e.g. Podman,
• .NET - .NET 9.0
• Azure functions core tools
• adr-tools
• GNU make 3.82 or later,

Note

The version of GNU make available by default on macOS is earlier than 3.82. You will need to upgrade it or certain make tasks will fail. On macOS, you will need Homebrew installed, then to install make, like so:

brew install make

You will then see instructions to fix your $PATH variable to make the newly installed version available. If you are using dotfiles, this is all done for you.

• Python required to run Git hooks,
• jq a lightweight and flexible command-line JSON processor.

Configuration

Rename the .env.example file to .env and populate the missing environment variables which are listed at the top of the file.

Usage

You can run the Azure functions with make all

Testing

The full test suite can be ran with make test.

Unit tests can be ran with make test-unit

OpenAPI Specifications

The following OpenAPI Specification exist for Service Layer:

• Service Layer API - Raw / Swagger Editor

API Request Collection

An API request collection for Service Layer exists in HAR format. It can be imported into Postman or Insomnia.

• Collection folder

Contacts

If you are on the NHS England Slack you can contact the team on #mays-team, otherwise you can open a GitHub issue.

Licence

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.

Any HTML or Markdown documentation is © Crown Copyright and available under the terms of the Open Government Licence v3.0.