Vets API endpoint punch list

Last Updated: April 29, 2025

In order to direct an external service to a Vets-API endpoint, service objects and associated controllers, routes, tests, and serializers need to be created.

Please go through the following list once the external service has been integrated. (Docs on adding a new external service integration are here, if needed.)

Service Object

Service class
Config class & Faraday connection
Breakers initializer
Response class
settings.yml (see the Settings and Parameter Store page)

Controller, Route & Serializer

Controller action
Route
Serializer (see the How to create a serializer page)

Frontend Signoff

Agreement on API schema

Swagger Docs

app/swagger/request/*
app/swagger/schema/*
app/controllers/v0/apidocs_controller.rb

Betamocks

Follow steps in the vets-api-mockdata repo

Spec Coverage

Service object specs
Request specs (including swagger_spec.rb)
VCR cassettes (see the Testing with VCR page)
Response schema

Source

Stems from the Endpoint Punch List Presentation
Source file for the presentation

Help and feedback

Suggest content changes to this page.
Submit new Platform Website content.
Get help from the Platform Support Team in Slack.
Submit a feature idea to the Platform.