![Distributed Monolith
Ben Christensen
models lib models lib
The Platform Libraries required to run services /
Libraries to interact with services
“The evils of too much coupling between services are far worse than the problems caused by code duplication”
Sam Newman
(Building Microservices)
Central Authority Technical evolution of teams
Polyglot Development Not possible
When a service cannot interact within a system unless all these libraries are available.
Per Conway’s Law, affects design
Extreme Programming DRY Principle Overdoing can result in Distributed Monolith
string jsonResponse = @"{
'Name': 'Bad Boys',
'ReleaseDate': '1995-4-7T00:00:00',
'Genres': [
'Action',
'Comedy'
]
}";
Movie m = JsonConvert.DeserializeObject<Movie>(json);
How to solve this??
leverage contracts and protocols
@SiddiqiMuhammad](https://image.slidesharecdn.com/swagger-161120195829/85/Swagger-OpenAPI-Spec-openapi-7-320.jpg)
![OpenAPI.next
Breaking change… :(
Hypermedia support
Extended JSON Schema support… any of, not operators
Callback style events / non request / response driven
HTTP 2.0 and socket techniques
WebHooks
Server could tell what sort of signatures are needed. Consumer sending message back.
[subscription, un-subscription, retry]
@SiddiqiMuhammad](https://image.slidesharecdn.com/swagger-161120195829/85/Swagger-OpenAPI-Spec-openapi-19-320.jpg)
Swagger & OpenAPI Spec #openapi
- 3. Agenda API Economy Issues with APIs Swagger’s Introduction & History Details about Swagger Spec Degree of RESTfulness Approaches for Swaggerizing Swagger Alternatives @SiddiqiMuhammad
- 4. Why so much interest in API Design? code camps - # Sessions discussing API Design & Dev What’s driving API Boom? By 2019, more than 30 percent of the 100 largest vendors' new software investments will have shifted from cloud-first to cloud-only. Gartner - Jun’16 The worldwide Internet of Things market is predicted to grow to $1.7 trillion by 2020, marking a compound annual growth rate of 16.9%. IDC Worldwide Internet of Things Forecast, 2015 – 2020. An estimated 25 billion connected “things” will be in use by 2020. – Gartner Newsroom API Economy @SiddiqiMuhammad
- 5. deux problèmes دومسائل mavuto awiri שתיבעיות 兩個問題 Due problemi مشكلتين iki sorun abụọ nsogbu రెండు సమసయలు dua masalah دومشکل Две проблемы Dos problemas Two problems @SiddiqiMuhammad
- 6. Pain for developers Using an REST API As a consumer As a provider Available Uris Parameters? Payloads Supporting user is hard Maintaining API documentation is difficult @SiddiqiMuhammad
- 7. Distributed Monolith Ben Christensen models lib models lib The Platform Libraries required to run services / Libraries to interact with services “The evils of too much coupling between services are far worse than the problems caused by code duplication” Sam Newman (Building Microservices) Central Authority Technical evolution of teams Polyglot Development Not possible When a service cannot interact within a system unless all these libraries are available. Per Conway’s Law, affects design Extreme Programming DRY Principle Overdoing can result in Distributed Monolith string jsonResponse = @"{ 'Name': 'Bad Boys', 'ReleaseDate': '1995-4-7T00:00:00', 'Genres': [ 'Action', 'Comedy' ] }"; Movie m = JsonConvert.DeserializeObject<Movie>(json); How to solve this?? leverage contracts and protocols @SiddiqiMuhammad
- 8. Swagger - Defines Interface to REST API - Language agnostic - API Specs / API Docs —-> JSON / YAML format - No guesswork in calling the service - Contract for REST Service OpenAPI SpecSwagger Eco-system - Documenting RESTful APIs - Open sourced @SiddiqiMuhammad
- 9. It has been there for a while… wordnik —-> SmartBear Open API Initiative -> working group under Linux foundation Swagger 2.0 is Open API Spec… Next version -> de-swaggered and would be called OAS 3.0 @SiddiqiMuhammad Many good people are behind it?
- 11. Discussion about Spec Metadata about API (name, description, host, basepath, …) Resources Parameters Responses Underlying Data Model Security @SiddiqiMuhammad
- 12. Discussion about Spec Metadata about API (name, description, host, basepath, …) Resources Parameters Responses Underlying Data Model Security @SiddiqiMuhammad
- 13. Discussion about Spec Metadata about API (name, description, host, basepath, …) Resources Parameters Responses Underlying Data Model Security @SiddiqiMuhammad
- 14. Swagger Structure - Data Types @SiddiqiMuhammad
- 15. - - - - - - - - - - - - API Spec Service Code Client code Swagger tools Contract First - - - - - - - - - - - - API Spec Client code Swagger tools Code First Service (Swagger-helper api) Approaches for Swagger-izing APIs ClientServer http @SiddiqiMuhammad
- 16. Swagger Community Google Group IRC Channel : #swagger Twitter http://apiawards.co/ @SiddiqiMuhammad
- 17. Is my API RESTful? Can this be answered as Yes / No? Are there degree of RESTfulness? 0 20 40 60 80 100 April Level 0: Swamp of POX Level 1: Resources Level 2: HTTP Verbs Level 3: HATEOAS Richardson’s Maturity Model Swagger 2.0 OpenAPI.next @SiddiqiMuhammad
- 18. Swagger.Ed Graphical Representation of API chrome extension @chefarchitect @SiddiqiMuhammad
- 19. OpenAPI.next Breaking change… :( Hypermedia support Extended JSON Schema support… any of, not operators Callback style events / non request / response driven HTTP 2.0 and socket techniques WebHooks Server could tell what sort of signatures are needed. Consumer sending message back. [subscription, un-subscription, retry] @SiddiqiMuhammad
- 21. Service First / Code First scalatra-swagger "com.wordnik" %% "swagger-play2" ASP.Net Web API —- > Swashbuckle Automated API Spec Generation? swagger-node-express SpringFox -> Automated JSON API documentation for API's built with Spring @SiddiqiMuhammad
- 22. Spec First / Contract First Swagger.io Editor Restlet SwaggerHub @SiddiqiMuhammad
- 23. Validating Swagger Spec Swagger Validator Badge <img src="http://online.swagger.io/validator?url={YOUR_URL}"> @SiddiqiMuhammad
- 24. Client Code Generation API Operations Model Classes Autorest NSwag swagger-codegen editor.swagger.io Restlet APIMATIC @SiddiqiMuhammad swagger-codegen generate -l html -i https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json
- 25. Documentation for Developers swagger-ui swagger-codegen asciidoctor?? — Swagger2Markup @SiddiqiMuhammad
- 26. Dynamic Client Code Generation SwaggerProvider: F# type provider Sergey Tihon Javascript Python @SiddiqiMuhammad
- 27. Where to find API Specs @SiddiqiMuhammad
- 28. Swagger and Postman Postman collections can be generated @SiddiqiMuhammad
Editor's Notes
- #3: What do you need to use an API? … Documentation
- #6: What do you need to use an API? … Documentation
- #7: increasing api use cases, continuous api delivery, API team collaboration. Applications are becoming more and more API centric Micro services Backends (apis - mobile, social bot, iot, web app) API Gateways (partner apis, public apis) Automated workflows
- #11: Makes consumption of your API easier by providing details about everything need to use your api. (methods, resources, parameters, media types) API adoption is affected by proper documentation This includes both private (in your enterprise) or public APIs.
- #12: What’s changed in 2.0? https://github.com/OAI/OpenAPI-Specification/wiki/Swagger-1.2-to-2.0-Migration-Guide models changed to schemas Resources removed. Operations are now described with paths. Multiple files changed to single file. only one base path allowed. Earlier versions allowed different base paths on operations level.
- #14: There are members which have one member in board of directors. There is also a technical committee, which you can be a part of.
- #15: http://openapi-specification-visual-documentation.apihandyman.io/
- #16: allOf: Mixin composition
- #17: http://apihandyman.io/writing-openapi-swagger-specification-tutorial-part-8-splitting-specification-file/
- #18: http://apievangelist.com/2015/03/30/quantifying-the-community-around-the-swagger-api-specification/
- #19: Code First: Code annotations, comments, embedded documentation No need to maintain separate spec Spec is always updated Design First: Here spec is the single truth about your api Spec is implementation guideline Spec is outside your code One apparent problem: what if somebody goes to the server code after generation and changes it. Well, if that happens then screw him, the clients would still be using the spec, so they might be broken. So the change would be immediately noticed. so you are fine.
- #20: http://apievangelist.com/2015/03/30/quantifying-the-community-around-the-swagger-api-specification/
- #21: Many developers have started using Postman as part of their API workflow. This can be added as part of the build workflow using its newman tool. We can generate postman collections by importing swagger spec directly from a URL. Once you create collections, you can share it with your team. You can keep a sample response with the collection and compare it with a future response. And so on…
- #23: Leonard Richardson HATEOAS: Hypermedia As The Engine Of Application States You let the hypermedia drive the interaction with the RESTful service. Web API is just another type of web application so why should be any different than the other web applications e.g. web sites. For using a website, we don’t need a formal training. We go to the main page, it has hyperlinks… and it goes on…REST APIs should also behave the same way. url tempting and swagger? Roy Fielding has made it clear that level 3 RMM is a pre-condition of REST. Like many terms in software, REST gets lots of definitions, but since Roy Fielding coined the term, his definition should carry more weight than most.
- #24: @chefarchitect: Chris Spiliotopoulos
- #25: apis.json is like a sitemap for website. it’s for APIs. It makes apis searchable by search engines. apis.json… swaggerHub uses that…
- #26: cookie as parameter Support for links
- #30: Show the API spec generated from Swashbuckle in ASP.Net
- #33: Editor: Use StudentAPI and show client and server code generation (swagger editor has code snippets and intellisense) Restlet: Create Test API with Restlet SwaggerHub: Show export to API Gateway Apiary: DreddAPI Tester: The implementation matches the spec. https://dredd.readthedocs.io/en/latest/hooks/
- #34: swagger validate https://api.apis.guru/v2/specs/nytimes.com/top_stories/2.0.0/swagger.json
- #36: Use swagger-codegen to generate java code for the API api docs (/Users/muhammadsiddiqi/Desktop/nyc/approaches/schema-first/swagger-codegen) - swagger-codegen generate -l dynamic-html -i https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json npm install node . (runs on 8002 [in main.js] - http://localhost:8002) (uses express) HTML swagger-codegen generate -l html -i https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json
- #37: swagger-ui is an interactive documentation Use swagger-codegen to generate java code for the API api docs (/Users/muhammadsiddiqi/Desktop/nyc/approaches/schema-first/swagger-codegen) - swagger-codegen generate -l dynamic-html -i https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json npm install node . (runs on 8002 [in main.js] - http://localhost:8002) (uses express) HTML swagger-codegen generate -l html -i https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json
- #38: SwaggerProvider nuget package Sergey Tihon
- #44: API Specs can be available by the API providers themselves. Then they have a responsibility to versioning and maintenance of the specs. https://watson-api-explorer.mybluemix.net/ Is there a public space available for API specs as we have package managers including nuget.org or npm / bower? Nothing official yet but APIs.GURU and API Stack are closer.
- #45: Many developers have started using Postman as part of their API workflow. This can be added as part of the build workflow using its newman tool. We can generate postman collections by importing swagger spec directly from a URL. Once you create collections, you can share it with your team. You can keep a sample response with the collection and compare it with a future response. And so on…
- #46: API Transformer is an APIMATIC tool.
- #47: Many developers have started using Postman as part of their API workflow. This can be added as part of the build workflow using its newman tool. We can generate postman collections by importing swagger spec directly from a URL. Once you create collections, you can share it with your team. You can keep a sample response with the collection and compare it with a future response. And so on…