Swagger does not officially support the Spray framework yet, but there is a community project that provides all the required integrations.
- View Offline
- [Andriy] In the previous video,…we briefly discussed the problems and challenges…of the documenting REST(ful) web services and APIs.…Among a couple of alternatives, we decided to pick Swagger,…and use it to document our Book application web services.…In this video, we're going to take a look…at how Swagger integrates with Spray applications.…Also, we're going to learn…different types of Swagger annotations,…how documentation is generated,…and how it is exposed to the outside world.…
As part of the video, we will document…all Book catalog web services and APIs…so that the external vendors and developers…will be able to integrate with us.…spray-swagger is a community-driven integration…of the Swagger project with Spray framework.…It is quite a thin layer built on top of Spray routing,…and essentially is encapsulated…in the trait SwaggerHttpService.…Under the hood, it uses a few other classes…in order to retrospect and assemble web API documentation.…
As a matter of fact, we are going to deal with…SwaggerHttpService only.…
Embark on an exciting journey into the universe of web development using the Scala programming language and frameworks—natural choices for back-end developers building highly scalable, reliable, and reactive RESTful web services and APIs. This training is the starting point for mastering the nonblocking and asynchronous programming models that lie in the heart of the Spray framework. It starts with an introduction to the REST architecture. Then switch gears to the Akka toolkit and framework, building a sample book catalog application along the way.
Once you've learned about the REST architectural style and Actor model—the foundations that the Spray framework is built upon—you'll shape out your own RESTful web services by providing simple route definitions. Further on in the course, author Andriy Redko delves into authentication and authorization, secure transport, documentation, testing, and caching support. Finally, you will learn how to develop the Spray client API to call external web services.
- The Actor model and Akka framework
- RESTful architecture principles and constraints
- Building RESTful services
- Core Spray framework modules such as spray-can, spray-routing, spray-json, spray-caching, and spray-client
- Securing RESTful web services and APIs with Spray
- Configuring Spray applications with HTTPS support
- Documenting Spray RESTful web services using Swagger
- Caching basics
- Calling external RESTful services