vets-api-endpoint-punch-list-slides.md

slideOptions	transition slideNumber slide true

Endpoint Punch List

---

Endpoint Code

---

Swagger Docs

---

Betamocks

---

Spec Coverage

---

Frontend Signoff

{
  "data": {
    "attributes": {
      "email": "john@example.com",
      "effective_at": "2018-02-27T14:41:32.283Z"
    }
  }
}

✅ ✅ ✅

---

Endpoint Code

---

---

Endpoint Creation

• Integrate an external service
• Service object
• Controller, route and serializer

---

Service Object

• Calls the service's endpoints
• Dependencies
  • Service class
  • Config class & Faraday connection
  • Response class
  • settings.yml

---

---

Service Object Implementation

---

Controller/Route/Serializer

---

Swagger Docs

---

Request/Response Docs

---

Model Docs

---

Swagger Files

app/swagger/requests/*

app/swagger/schemas/*

app/controllers/v0/apidocs_controller.rb

Swagger implementation

---

Betamocks

---

Betamocks Process

1. Set config
2. Create recording
3. Update mock data table

---

Betamocks Config

---

Betamocks Recording & Mock Data Table

---

Spec Coverage

---

Spec Areas

• Service object specs
• Request specs
• VCR cassettes
• Response schema
• Spec files examples

---

match_response_schema

expect(response).to match_response_schema(
  'email_address_response'
)

---

match_response_schema Implementation

---

In Conclusion

---

Endpoint Punch List

---

Resources

• Integrate an external service
• Email address endpoint PR
• Email address Betamocks config PR
• Email address Betamocks recording PR
• Setup Swagger locally
• Setup Betamocks
• vets-api-mockdata readme
• Endpoint Punch List

---

Questions?

---

Thanks!