https://github.com/nhsdigital/service-search-api
https://github.com/nhsdigital/service-search-api
Last synced: about 13 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/nhsdigital/service-search-api
- Owner: NHSDigital
- License: other
- Created: 2022-05-20T08:04:29.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2026-01-12T11:34:13.000Z (8 days ago)
- Last Synced: 2026-01-12T19:24:05.280Z (7 days ago)
- Language: JavaScript
- Size: 2.6 MB
- Stars: 1
- Watchers: 33
- Forks: 2
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# service-search-api
This is a specification for the _service-search-api_ API.
- `specification/` This [Open API Specification](https://swagger.io/docs/specification/about/) describes the endpoints, methods and messages exchanged by the API. Use it to generate interactive documentation; the contract between the API and its consumers.
- `sandbox/` This NodeJS application implements a mock implementation of the service. Use it as a back-end service to the interactive documentation to illustrate interactions and concepts. It is not intended to provide an exhaustive/faithful environment suitable for full development and testing.
- `scripts/` Utilities helpful to developers of this specification.
- `proxies/` Live (connecting to another service) and sandbox (using the sandbox container) Apigee API Proxy definitions.
Consumers of the API will find developer documentation on the [NHS Digital Developer Hub](https://digital.nhs.uk/developer).
## Contributing
Contributions to this project are welcome from anyone, providing that they conform to the [guidelines for contribution](https://github.com/NHSDigital/service-search-api/blob/master/CONTRIBUTING.md) and the [community code of conduct](https://github.com/NHSDigital/service-search-api/blob/master/CODE_OF_CONDUCT.md).
### Licensing
This code is dual licensed under the MIT license and the OGL (Open Government License). Any new work added to this repository must conform to the conditions of these licenses. In particular this means that this project may not depend on GPL-licensed or AGPL-licensed libraries, as these would violate the terms of those libraries' licenses.
The contents of this repository are protected by Crown Copyright (C).
## Development
### Requirements
- make
- nodejs + npm/yarn
- [poetry](https://github.com/python-poetry/poetry)
- Java 8+
For step by step instructions on making these installations, refer to scripts/install_prerequisites.txt. These installations should only have to be done once.
### Install
```
$ make install
```
#### Updating hooks
You can install some pre-commit hooks to ensure you can't commit invalid spec changes by accident. These are also run
in CI, but it's useful to run them locally too.
```
$ make install-hooks
```
### Environment Variables
Various scripts and commands rely on environment variables being set. These are documented with the commands.
:bulb: Consider using [direnv](https://direnv.net/) to manage your environment variables during development and maintaining your own `.envrc` file - the values of these variables will be specific to you and/or sensitive.
### Make commands
There are `make` commands that alias some of this functionality:
- `lint` -- Lints the spec and code
- `publish` -- Outputs the specification as a **single file** into the `build/` directory
- `serve` -- Serves a preview of the specification in human-readable format
### Testing
Currently this repository only has smoketests.
```
make smoketest
```
These require the [APIGEE get_token tool](https://docs.apigee.com/api-platform/system-administration/using-gettoken) and a correctly configured environment:
```
SSO_LOGIN_URL=https://login.apigee.com
APIGEE_ENVIRONMENT="internal-dev"
SERVICE_BASE_PATH="service-search-api"
APIGEE_API_TOKEN="$(get_token)"
SOURCE_COMMIT_ID="7aad0db8d58e2f67eeaf7b2ebc930fceb18b991a"
```
### VS Code Plugins
- [openapi-lint](https://marketplace.visualstudio.com/items?itemName=mermade.openapi-lint) resolves links and validates entire spec with the 'OpenAPI Resolve and Validate' command
- [OpenAPI (Swagger) Editor](https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi) provides sidebar navigation
### Emacs Plugins
- [**openapi-yaml-mode**](https://github.com/esc-emacs/openapi-yaml-mode) provides syntax highlighting, completion, and path help
### Speccy
>> [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator-cli) *OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec*
OpenAPI Generator does the lifting for the following npm scripts:
* `lint` -- Lints the definition
* `publish` -- Outputs the specification as a **single file** into the `dist/` directory
>> [ReDocly](https://redocly.com/docs) does the lifting for the serve npm script.
* `serve` -- Uses redocly command preview-docs to serve a preview of the specification in human-readable format
(Workflow detailed in a [post](https://developerjack.com/blog/2018/maintaining-large-design-first-api-specs/) on the _developerjack_ blog.)
:bulb: The `publish` command is useful when uploading to Apigee which requires the spec as a single file.
### Caveats
#### Swagger UI
Swagger UI unfortunately doesn't correctly render `$ref`s in examples, so use `speccy serve` instead.
#### Apigee Portal
The Apigee portal will not automatically pull examples from schemas, you must specify them manually.