Easy REST with OpenAPI
0 likes445 views
This document discusses using OpenAPI to easily create REST APIs. It introduces OpenAPI, which allows specifying API calls and data constraints in a JSON specification. This specification can then be serialized and consumed by clients to automatically generate spec-conform requests. The document also provides a link to a GitHub repository containing an example of using OpenAPI in Pharo.
![OpenAPI Spec
…
"/pets/{petId}" : {
"get" : {
"summary" : "A call to acquire a pet",
"operationId" : "fetchPet",
"parameters" : [
{
"name" : "petId",
"in" : "path",
"schema" : {
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : …](https://image.slidesharecdn.com/openapi-190502092124/85/Easy-REST-with-OpenAPI-12-320.jpg)
Easy REST with OpenAPI
- 1. Easy REST with OpenAPI Norbert Hartl ZWEIDENKER GmbH
- 2. ZWEIDENKER GmbH • 10 years old • Software solutions for mobile, web and backend-only, too • Pharo usage is growing steadily • In cologne and organizing this year’s ESUG
- 3. REST
- 6. REST • It uses HTTP
- 7. REST • It uses HTTP • It is resource based
- 8. REST • It uses HTTP • It is resource based • It is not RPC
- 9. REST • It uses HTTP • It is resource based • It is not RPC • It’s about hyper media
- 10. REST usually means • Extract and validate parameters from request • Checking constraints of payload • Produce documented response
- 11. JSON Schema { #name -> (JSONSchema string). #age -> (JSONSchema integer) } asJSONSchema
- 12. OpenAPI Spec … "/pets/{petId}" : { "get" : { "summary" : "A call to acquire a pet", "operationId" : "fetchPet", "parameters" : [ { "name" : "petId", "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : …
- 13. DEMO
- 14. OpenAPI • Specify Calls and data constraints • Serialize to JSON spec • Can be consumed by a client to automatically create spec conform requests
- 15. Questions?