Endpoint Punch List

--- slideOptions: transition: slide slideNumber: true ---  <div style="background-color: rgba(0, 0, 0, 0.7); color: #fff; padding: 20px; margin: 0 -1em;"> # Endpoint Punch List </div> ---  <div style="background-color: rgba(0, 0, 0, 0.5); color: #fff; padding: 20px;"> # Endpoint Code </div> ---  <div style="background-color: rgba(0, 0, 0, 0.5); color: #fff; padding: 20px;"> # Swagger Docs </div> ---  <div style="background-color: rgba(0, 0, 0, 0.5); color: #fff; padding: 20px;"> # Betamocks </div> ---  <div style="background-color: rgba(0, 0, 0, 0.5); color: #fff; padding: 20px;"> # Spec Coverage </div> ---  # Frontend Signoff ```javascript { "data": { "attributes": { "email": "john@example.com", "effective_at": "2018-02-27T14:41:32.283Z" } } } ``` :white_check_mark: :white_check_mark: :white_check_mark: ---  # 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](https://gist.github.com/hpjaj/67eeb7cc5f69ac672d0176fcb1f06dc7) ---  ## [Controller/Route/Serializer](https://gist.github.com/hpjaj/0780168e80d5a4ae09a17d35b8bb6328) ---  # Swagger Docs ---  <div style="background-color: rgba(0, 0, 0, 0.5); color: #fff; padding: 20px; margin-bottom: 8em;"> ## Request/Response Docs </div> ---  <div style="background-color: rgba(0, 0, 0, 0.5); color: #fff; padding: 20px; margin-bottom: 8em;"> ## Model Docs </div> ---  # Swagger Files ```bash app/swagger/requests/* ```  ```bash app/swagger/schemas/* ```  ```bash app/controllers/v0/apidocs_controller.rb ```  [Swagger implementation](https://gist.github.com/hpjaj/2d0d332d39e77aed6bdb993268d01078) ---  # Betamocks ---  # Betamocks Process 1. Set config 2. Create recording 3. Update mock data table ---  ## [Betamocks Config](https://gist.github.com/hpjaj/3ff754ace8bfd7e56ce5abb48a8314e8) ---  ## [Betamocks Recording & Mock Data Table](https://gist.github.com/hpjaj/def97d12c67902e6d2af7e628a0870e5) ---  # Spec Coverage ---  # Spec Areas - Service object specs - Request specs - VCR cassettes - Response schema - [Spec files examples](https://gist.github.com/hpjaj/a9ffc192a75fc3d5726404a3ddc07942) ---  ## `match_response_schema` ```ruby expect(response).to match_response_schema( 'email_address_response' ) ```  ---  ### [`match_response_schema` Implementation](https://gist.github.com/hpjaj/2f1be22e1bca1d694a574812e97f32b4) ---  # In Conclusion ---  <div style="background-color: rgba(0, 0, 0, 0.8); color: #fff; padding: 20px;"> ## [Endpoint Punch List](https://github.com/department-of-veterans-affairs/va.gov-vfs-teams/blob/master/DeveloperDocs/vets-api/vets-api-endpoint-punch-list.md) </div> ---  # Resources - [Integrate an external service](https://github.com/department-of-veterans-affairs/devops/tree/master/docs/External%20Service%20Integrations) - [Email address endpoint PR](https://github.com/department-of-veterans-affairs/vets-api/pull/1718) - [Email address Betamocks config PR](https://github.com/department-of-veterans-affairs/vets-api/pull/1746) - [Email address Betamocks recording PR](https://github.com/department-of-veterans-affairs/vets-api-mockdata/pull/13) - [Setup Swagger locally](https://github.com/department-of-veterans-affairs/vets-api/tree/master/app/swagger) - [Setup Betamocks](https://github.com/department-of-veterans-affairs/vets-api/blob/master/docs/setup/betamocks.md) - [vets-api-mockdata readme](https://github.com/department-of-veterans-affairs/vets-api-mockdata/blob/master/README.md) - [Endpoint Punch List](https://github.com/department-of-veterans-affairs/va.gov-vfs-teams/blob/master/DeveloperDocs/vets-api/vets-api-endpoint-punch-list.md) ---  # Questions? ---  # Q & A Takeaways - get the API correct, collaborate with the architects - dealing smartly and proactively with the error edge cases - insight into how the middleware is being instrumented, and references to them - alphabetize the Swagger API endpoints - automate the inclusion of the files in the apidocs controller ---  # Thanks!