RESTful API Design and Development Overview
This RESTful API Design and Development course teaches attendees the core concepts and practices for RESTful API design and development.
The course focuses on the principles for designing a RESTful JSON API. Core concepts and best practices are covered for both development and consumption of a RESTful API.
View our 5-Minute API Design tutorials.
Location and Pricing
Accelebrate offers instructor-led enterprise training for groups of 3 or more online or at your site. Most Accelebrate classes can be flexibly scheduled for your group, including delivery in half-day segments across a week or set of weeks. To receive a customized proposal and price quote for private corporate training on-site or online, please contact us.
In addition, some courses are available as live, instructor-led training from one of our partners.
Objectives
- Consider web architecture as the basis of API strategies
- Understand the REST architectural style and its motivations
- Utilize the Richardson Maturity Model as a way to discuss design choices and induced properties
- Implement security measures
- Work with client technologies
- Incorporate API management approaches
- Implement testing strategies
- Think about REST APIs vs. linked data, RPC models and GraphQL
Prerequisites
Other than object-oriented development or architecture experience, no prior expertise is presumed.
Outline
Expand All | Collapse All
Introduction
- API Breakdown of Players
- How did we get here?
Current state of API
- API Strategies
- OpenAPI
- Tools
- Definitions and Standards
- Demos and Labs
API Design
- General design concepts (separation of concern, error handling, API vs. RPC, etc.)
Paths
- GET
- Design in OpenAPI
- Verbs Details
- Query String Parameters
Separation of Concerns
- Gathering
- Formatting
- Delivery
- Security and Scalability
- Operation Responses
- OpenAPI Schema
Richardson Maturity Model
- Levels 0-3
- Hypermedia/HATEOAS
Example APIs
API Development Standards
- OpenAPI
- Benefits
- Maturity
- Parameters
- POST, PUT and PATCH
- HEAD, OPTIONS and TRACE
OpenAPI Tools
- Overview
- Insomnia
- Local Typicode Server
CRUD: Create
- POST Create
- Request Body Schema
- Combining Schemas
- Responses in Components
- Array Schema Type
Server Variables
Parameters
- Path, header and cookie
- Required, default, min/max, enum
- Path Level Reuse
- Serialization
- Styles and Explode
CRUD: Delete
Design First vs. Develop First
Automated Testing
- Tools, Insomnia
- Chai JS Assertion Library
Legacy API Considerations
- Database
- Endpoints
- Functionality
Security
- Documentation Options
- Authentication vs. Authorization
- JWT
- Security Definitions in OpenAPI
Pet Store API Review
Automated Testing Principles
- Best Practices
- Integration Testing
- Insomnia CLI
- GitHub Actions
Tutorials
- Jetty Web API Servlet
- C# .NET Server
- Java Server using Spark
- Python Server using Flask
Conclusion
Training Materials
All RESTful API Design and Development students will receive comprehensive courseware including slides, design exercises, and sample solutions.
Software Requirements
- Google Chrome
- Other modern browsers as desired
- Other free software and lab files that Accelebrate would specify, including Node.js
