Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/pack-template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ jobs:
dotnet-version: '8.0.x'

- name: Install GitVersion (v5)
uses: gittools/actions/gitversion/setup@v0.9
uses: gittools/actions/gitversion/setup@v4.7.0
with:
versionSpec: '5.x'
versionSpec: '6.x'

- name: Add .NET global tools to PATH
run: echo "$HOME/.dotnet/tools" >> $GITHUB_PATH
Expand Down
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,21 @@ The Persons API is a service that provides contact information and basic persona
## Technologies

.NET, JSON, OpenAPI, Web API

## Authenticating for Swagger

The Swagger UI requires an authentication token to access the API. You can obtain a token via Postman. Import the Postman collection and environment from the `Postman` folder.
You will need to ask a colleague to provide you with the `Secret` and `ClientId` values.
You should now be able to generate a new access token. You can either call the endpoints in Postman or use the token in the Swagger UI.

## Running the API locally

You can run a local instance of the Academies database, or alternatively, you can connect to the Dev or Test instance of the database.

Replace the "DefaultConnection" string in `appsettings.Development.json` with the appropriate connection string for your environment, e.g.

`"Server=srv-t1dv-sips.database.windows.net;Database=sip;User Id=<id_here>;Password=<password_here>"`

Build and run the application as you usually would.

Create a token using Postman (see above) and paste it into the Swagger UI, or call your locally hosted endpoints in Postman.
33 changes: 33 additions & 0 deletions postman/PersonsAPI-Dev-Test.postman_environment.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"id": "c5c147b1-8292-409f-8d52-fd17d4c1752a",
"name": "PersonsAPI-Dev-Test",
"values": [
{
"key": "Secret",
"value": "",
"type": "secret",
"enabled": true
},
{
"key": "ClientId",
"value": "",
"type": "default",
"enabled": true
},
{
"key": "Scope",
"value": "api://930a077f-43d0-48cb-9316-1e0430eeaf6b/.default",
"type": "default",
"enabled": true
},
{
"key": "bearer_token",
"value": "",
"type": "default",
"enabled": true
}
],
"_postman_variable_scope": "environment",
"_postman_exported_at": "2025-09-24T15:48:03.449Z",
"_postman_exported_using": "Postman/11.62.6"
}
Loading
Loading