Валидация “REST” API по документации APIB

Transcript

1. Валидация “REST” API по документации APIB
2. “REST” API?
3. APIB?
4. API Blueprint
5. API Blueprint?
6. Markdown (роуты и описание) + MSON (описание тел) = API Blueprint
7. API Blueprint => API Elements Swagger => API Elements
8. API Elements?
9. AST + json-schema = API Elements
10. API Elements => Tomogram
11. Tomogram?
12. роуты + json-schema = Tomogram
13. Tomogram = массив Request(ов)
14. Request = method path json-schema массив response(ов)
15. Response = status json-schema
16. API Blueprint => API Elements => Tomogram
17. Esplanade!
18. Esplanade?
19. Эспланада — широкое открытое пространство перед крепостью. Чтобы затруднить нападение на крепость, пространство перед ней оставляли открытым, вырубая все деревья и запрещая строить дома. Из-за этого войска противника не могли приблизиться к крепости незамеченными или укрыться от обстрела.
20. “Firewall”
21. just do it Gemfile: gem ‘esplanade' config/application.rb config.middleware.use Esplanade::SafeMiddleware, apib_path: 'doc.apib'
22. и напишем документацию # Backend ## Users [/users] ### To viewing [GET] + Request (application/json) + Attributes + name (string, required) + Response 200 (application/json)
23. rake routes users GET /users(.:format) users#index
24. 1 кейс запрос не реализован/не описан curl -v -X GET http://localhost:3000/ qwerty
25. ESPLANADE SKIP: #<Esplanade::Request::NotDocumented: {:method=>"GET", :path=>"/qwerty"}> ESPLANADE SKIP: #<Esplanade::Response::NotDocumented: {:request=>{:method=>"GET", :path=>"/ qwerty"}, :status=>”404"}>
26. 2 кейс тело запроса не json curl -v -X GET http://localhost: 3000/users -d name=Dima
27. ESPLANADE SKIP: #<Esplanade::Request::BodyIsNotJson: {:method=>"GET", :path=>"/ users", :body=>"name=Dima"}> Processing by UsersController#index as */* Parameters: {"name"=>"Dima"} Completed 200 OK in 0ms (Views: 0.2ms) ESPLANADE SAYS THAT THE RESPONSE IS VALID
28. 3 кейс тело запроса не валидно curl -v -X GET http://localhost:3000/users - d '{"name": 1}'
29. ESPLANADE SKIP: #<Esplanade::Request::Invalid: {:method=>"GET", :path=>"/users", :body=>"{\"name\": 1}", :error=>["The property '#/name' of type integer did not match the following type: string in schema d273bcdd-74f5-5e93-968b-49eb22dd5bc0"]}> Processing by UsersController#index as */* Parameters: {"{\"name\": 1}"=>nil} Completed 200 OK in 0ms (Views: 0.2ms) ESPLANADE SAYS THAT THE RESPONSE IS VALID
30. 4 кейс все валидно curl -v -X GET http://localhost:3000/users - d '{"name": “Dima"}'
31. ESPLANADE SAYS THAT THE REQUEST IS VALID Processing by UsersController#index as */* Parameters: {"{\"name\": \"Dima\"}"=>nil} Completed 200 OK in 0ms (Views: 0.1ms) ESPLANADE SAYS THAT THE RESPONSE IS VALID
32. так что с валидацией?
33. config.middleware.use Esplanade::CheckCustomResponseMiddleware, apib_path: ‘doc.apib' config.middleware.use YourMiddleware config.middleware.use Esplanade::DangerousMiddleware, apib_path: 'doc.apib'
35. зачем это все?
36. не потерять контроль над API прозрачность (sentry, grafana) понятность Documentation-Driven Development полное соответствие реализации документации
37. можно ли использовать “firewall” не в ruby проектах?