Skip to content

Commit 644161f

Browse files
authored
Referencing API policies and best practices (#286)
* referencing API policies and best practices * adding new line as per formatting rules * referencing API policies and best practices * adding new line as per formatting rules * updating file name for consistency
1 parent c791140 commit 644161f

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

practices/api-policies.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# API policies and best practice
2+
3+
## Context
4+
5+
These notes are part of a broader set of [principles](../principles.md). See also [cloud services](cloud-services.md).
6+
7+
## Details
8+
9+
NHSDigital has published guidance on [policies and best practices](https://digital.nhs.uk/developer/guides-and-documentation/api-policies-and-best-practice) around APIs. For projects using APIs, development and engineerng teams should review these guides to assist in building good quality, easy to use healthcare APIs.

quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This contains cloneable scripts, docker files, and pipeline steps that can be ad
2626
The entire team should familiarise themselves with the Framework's [Principles](principles.md).
2727
And with the common [Patterns](patterns) that help achieve those Principles.
2828

29-
Specialists should familiarise themselves with [best Practices](practices) in their areas.
29+
Specialists should familiarise themselves with [best Practices](practices) in their areas. Teams building APIs should refer to the [policies and best practice guidance](https://digital.nhs.uk/developer/guides-and-documentation/api-policies-and-best-practice) on building APIs.
3030

3131
Run a quality review every 3 months to keep track of progress.
3232

0 commit comments

Comments
 (0)