Unlock dependency between client teams and API team with API mock and proxy
0 likes487 views
The document discusses using API mocks and proxies to decouple client teams from the API team during development. It allows each team to work independently by providing a mock or proxy API for clients to test against while the real API is still being developed. This prevents client work from being blocked waiting on the API team. The document provides examples of how different clients like iOS, web, and Android could each use a mock API during development before integrating with the final API endpoint from the backend team.
![### List All Questions [GET]
+ Response 200 (application/json)
[
{
"question": "Favourite programming language?",
"published_at": "2014-11-11T08:40:51.620Z",
"url": "/questions/1",
"choices": [
{
"choice": "Swift",
"url": "/questions/1/choices/1",
"votes": 2048
}, {
"choice": "Python",
"url": "/questions/1/choices/2",
"votes": 1024
}, {
"choice": "Objective-C",
"url": "/questions/1/choices/3",
"votes": 512
}, {
"choice": "Ruby",
"url": "/questions/1/choices/4",
"votes": 256
}
]
}
]](https://image.slidesharecdn.com/rails-pacific-lighting-talk-160520152526/85/Unlock-dependency-between-client-teams-and-API-team-with-API-mock-and-proxy-4-320.jpg)
![]
### Create a New Question [POST]
You may create your own question using this action. It takes a JSON object
containing a question and a collection of answers in the form of choices.
+ question (string) - The question
+ choices (array[string]) - A collection of choices.
+ Request (application/json)
{
"question": "Favourite programming language?",
"choices": [
"Swift",
"Python",
"Objective-C",
"Ruby"
]
}
+ Response 201 (application/json)
+ Headers
Location: /questions/1
+ Body
{
"question": "Favourite programming language?",](https://image.slidesharecdn.com/rails-pacific-lighting-talk-160520152526/85/Unlock-dependency-between-client-teams-and-API-team-with-API-mock-and-proxy-5-320.jpg)
![+ Response 201 (application/json)
+ Headers
Location: /questions/1
+ Body
{
"question": "Favourite programming language?",
"published_at": "2014-11-11T08:40:51.620Z",
"url": "/questions/1",
"choices": [
{
"choice": "Swift",
"url": "/questions/1/choices/1",
"votes": 0
}, {
"choice": "Python",
"url": "/questions/1/choices/2",
"votes": 0
}, {
"choice": "Objective-C",
"url": "/questions/1/choices/3",
"votes": 0
}, {
"choice": "Ruby",
"url": "/questions/1/choices/4",
"votes": 0
}
]
}](https://image.slidesharecdn.com/rails-pacific-lighting-talk-160520152526/85/Unlock-dependency-between-client-teams-and-API-team-with-API-mock-and-proxy-6-320.jpg)
![{
"choice": "Swift",
"url": "/questions/1/choices/1",
"votes": 0
}, {
"choice": "Python",
"url": "/questions/1/choices/2",
"votes": 0
}, {
"choice": "Objective-C",
"url": "/questions/1/choices/3",
"votes": 0
}, {
"choice": "Ruby",
"url": "/questions/1/choices/4",
"votes": 0
}
]
}
AND 9,000+ LINES](https://image.slidesharecdn.com/rails-pacific-lighting-talk-160520152526/85/Unlock-dependency-between-client-teams-and-API-team-with-API-mock-and-proxy-7-320.jpg)
Unlock dependency between client teams and API team with API mock and proxy
- 1. Unlock dependency between client teams and API team with API mock and proxy Bruce Li @ascendbruce Rails Pacific 2016 ⚡
- 2. API Implementation Code Review DeployQA API Implementation Code Review DeployQA Web Client Implementation Android APP Implementation iOS App Implementation API design change
- 4. ### List All Questions [GET] + Response 200 (application/json) [ { "question": "Favourite programming language?", "published_at": "2014-11-11T08:40:51.620Z", "url": "/questions/1", "choices": [ { "choice": "Swift", "url": "/questions/1/choices/1", "votes": 2048 }, { "choice": "Python", "url": "/questions/1/choices/2", "votes": 1024 }, { "choice": "Objective-C", "url": "/questions/1/choices/3", "votes": 512 }, { "choice": "Ruby", "url": "/questions/1/choices/4", "votes": 256 } ] } ]
- 5. ] ### Create a New Question [POST] You may create your own question using this action. It takes a JSON object containing a question and a collection of answers in the form of choices. + question (string) - The question + choices (array[string]) - A collection of choices. + Request (application/json) { "question": "Favourite programming language?", "choices": [ "Swift", "Python", "Objective-C", "Ruby" ] } + Response 201 (application/json) + Headers Location: /questions/1 + Body { "question": "Favourite programming language?",
- 6. + Response 201 (application/json) + Headers Location: /questions/1 + Body { "question": "Favourite programming language?", "published_at": "2014-11-11T08:40:51.620Z", "url": "/questions/1", "choices": [ { "choice": "Swift", "url": "/questions/1/choices/1", "votes": 0 }, { "choice": "Python", "url": "/questions/1/choices/2", "votes": 0 }, { "choice": "Objective-C", "url": "/questions/1/choices/3", "votes": 0 }, { "choice": "Ruby", "url": "/questions/1/choices/4", "votes": 0 } ] }
- 7. { "choice": "Swift", "url": "/questions/1/choices/1", "votes": 0 }, { "choice": "Python", "url": "/questions/1/choices/2", "votes": 0 }, { "choice": "Objective-C", "url": "/questions/1/choices/3", "votes": 0 }, { "choice": "Ruby", "url": "/questions/1/choices/4", "votes": 0 } ] } AND 9,000+ LINES
- 9. specific behavior to be tested?
- 10. DEMO
- 14. Awesome-ize rails console in 3 steps 1. gem 'awesome_rails_console' 2. bundle install 3. rails g awesome_rails_console:install DEMO
- 15. @ascendbruce toyroom.bruceli.net Thank you We’re hiring Tweet me your feedback Blog post version of this talk is coming soon