Skip to content

Instantly share code, notes, and snippets.

@hpjaj

hpjaj/endpoint-punch-list.md

Last active March 20, 2018 02:23
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save hpjaj/47d9116b7156beed8b8eaffc1a2f27da to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save hpjaj/47d9116b7156beed8b8eaffc1a2f27da to your computer and use it in GitHub Desktop.
Download ZIP
Raw
endpoint-punch-list.md

Endpoint Punch List

Once the external service has been integrated:

Service Object

  • Service class
  • Config class & Faraday connection
  • Response class
  • settings.yml

Controller, Route & Serializer

  • Controller action
  • Route
  • Serializer

Frontend Signoff

  • Agreement on API schema

Swagger Docs

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

Betamocks

  • Config - vets-api/config/betamocks/services_config.yml
  • Config - vets-api/config/settings.yml
  • Create recording file
  • Update vets-api-mockdata/make_table.rb
  • Update vets-api-mockdata/users.csv if applicable

Spec Coverage

  • Service object specs
  • Request specs
  • VCR cassettes
  • Response schema
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment