Packt+ | Advance your knowledge in tech

You're reading from Building Applications with Spring 5 and Vue.js 2

Product type Book

Published in Oct 2018

Publisher Packt

ISBN-13 9781788836968

Pages 590 pages

Edition 1st Edition

Languages

Java

Concepts

Full Stack Web Development

Author (1):

James J. Ye

Table of Contents (23) Chapters

Title Page

Dedication

About Packt

Contributors

Preface

1. Modern Web Application Development - This Is a New Era

2. Vue.js 2 - It Works in the Way You Expected

3. Spring 5 - The Right Stack for the Job at Hand

4. TaskAgile - A Trello-like Task Management Tool

5. Data Modeling - Designing the Foundation of the Application

6. Code Design - Designing for Stability and Extensibility

7. RESTful API Design - Building Language Between Frontend and Backend

8. Creating the Application Scaffold - Taking off Like a Rocket

9. Forms and Validation - Starting with the Register Page

10. Spring Security - Making Our Application Secure

11. State Management and i18n - Building a Home Page

12. Flexbox Layout and Real-Time Updates with WebSocket - Creating Boards

13. File Processing and Scalability - Playing with Cards

14. Health Checking, System Monitoring - Getting Ready for Production

15. Deploying to the Cloud with Jenkins - Ship It Continuously

1. Other Books You May Enjoy

Leave a review - let other readers know what you think

Index

RESTful API design procedure

Now that we've learned what a RESTful API is and the characteristics of a RESTful API, let's talk about how to design a RESTful API; that is, the procedure of API design.

Finding out the requirements

When designing RESTful APIs, you should start by listing what the clients of the APIs need to be able to do. For internal APIs, it is straightforward. You can get these requirements by discussing this with the developers of the frontend to find out the interactions that the frontend needs to have with the backend, which usually involves reviewing user stories and UI design work. For public APIs, you need to talk to the developers of the clients of your APIs, ask them their requirements and what problems they need to solve and find out what is common in their needs.

Identifying resources

Once you have gathered the requirements, you do the domain analysis and identify the resources that need to be exposed. Be careful with the APIs that you make publicly available since...