RESTTful API description - KalleTapsa/PWP-API GitHub Wiki
📑 Chapter summary
This chapter must provide a good overview of the Web API that your group is going to develop during the course, and some insight into the (imaginary) microservice architecture it will be a part of. You should not focus in implementation aspects such as database structure, interfaces or the request/responses formats. We recommend that you look into existing APIs (see Related work below) before writing the description for your own API.- Understand what is an API
- Describe the project topic API
- Describe how the API would be used as part of a larger architecture
✔️ Chapter evaluation (max 5 points)
You can get a maximum of 5 points after completing this Chapter. More detailed evaluation is provided in the evaluation sheet in Lovelace.📑 Content that must be included in the section
Describe the API you are going to implement. Also describe the larger imaginary architecture that would exist around that API - while you do not need to implement these other components, they will be helpful in imagining context for your API. Your API will be a component that stores, and offers an interface to, some important data in the larger ecosystem. Think about a larger system, and then take out one key piece to examine - this will be your API.
Describe the API briefly and comment what is the main functionality that it exposes. Focus in the API not in any specific application that is using this API. Take into account that in the end, a WEB API is an encapsulated functionality as well as the interface to access that functionality. Remember that your API is just one part of a larger machine. It does not need to do everything. There will be other components in the system to do those things. This course focuses on creating a small API in detail - thinking too big from the start will drown you in work later.
A really short version of an overview for the RESTful Web API could be:
“The discussion forum Web API offers different functionalities to structure non-real-time conversations among the people of a group about topics they are interested in certain topic. Messages are grouped in Threads, that at the same time are grouped in Topics. The messages are accessible to anyone, but posts can only be created by providing credentials of a registered user [...] This API could exist as part of an online learning environment system where it is responsible for offering discussion forum features that can be included in other components of the learning environment. For example, a programming task (managed by a different component) can include its own discussion board managed by the discussion forum API[...]“
The Useful Calendar API offers the user a simplistic way to keep track of their calendar. You can add time specific event and day specific events. For time specific events you have to give a staring time, ending time, a title, and an optional description. Day specific events do not need a specified timeframe. They contain only the day, title, and a optional description. For both kinds of events the user also chooses if the event is one-time, weekly, etc. This API could be used for any kind of calendar application or website.
📑 Content that must be included in the section
Define the main concepts and describe the relations among them textually. Roughly, a concept is a real-world entity that is expected to be of interest to users or other services. This section will be a guideline for choosing your resources to implement in Deadline 3. Students should remember that some of the concepts might not be a resource by themselves, but just a part of it (resource property). In this section, students should not describe the RESTful resources, but identify which are the main ideas of the API. Do not forget to include the relations among the concepts.A description of the main concepts for the Forum API could be:
"The API permits users send messages. The forum contains a list of categories and a list of users. Each category specifies a name, a description and a thread. A thread is [...]The forum may contain 0 or more categories… Each category may have 0 or more threads… Users can write and read messages to a forum thread. A user has a profile, basic information, activity information (stores, for instance, all the messages sent by a user, the messages marked as favorites). [...]The user history contains information of the last 30 messages sent by the user.[…]"
Include a diagram which shows the relations among concepts.
This section is important because it outlines the concepts that you will later implement. In particular, the diagram defined here will follow you throughout the project report and you will be adding more details to it.
The API permits the user to create events for their calendar. The API contains the calendar and the calendar consists of weeks, with each week containing whole seven days. Each day holds a list of events if any events has been set for that day. If not, then it just shows nothing for that day. Each event can be time-specific or just a plain event. Plain event has to have the date, title, and an optional description. Time-specific event has to have an starting time, an end time, title, and an optional description. User can add, edit, or remove the events. events have a option that when they are completed you can mark them as so.
📑 Content that must be included in the section
Describe at least one client and one service that could use your Web API. You must explain here what is the functionality provided by the client/service, and how it uses the Web API to implement this functionality.Client: Productivity tracker mobile application. This app would provide the users a simplistic way to manage their daily activities. It would use the API to fetch the user's events for the specific week, display them in a calendar view, and allow the user to see what events they have for that week. User could add, edit, or delete events from the calendar. Events could also be marked completed.
Service: Team collaboration tool. Service would help team members coordinate their tasks by allowing members to share their schedules with each other. The API would be used to retrieve and update team members event lists, so that everyone would have access to the latest schedule changes. It could also send notifications for events that are happening soon or events that have been deleted, so that team members stay organized on what is happening.
📑 Content that must be included in the section
Find at least one API that resembles the functionality provided by yours. Explain in detail the functionality provided by the API. Classify the API according to its type (RPC, CRUD REST, pure REST, hypermedia driven ...) justifying your selection. Provide at least one example client that uses this API.The purpose of this task is to get more familiar with what an API is. This will be helpful in describing your own API. Therefore, it is recommended to do this section after you have decided the topic of your project but before writing your API description.
Google Calendar API, it is a CRUD RESTful API. This is because it uses POST, GET, PUT and DELETE but doesn't follow all pure REST principles. You can create events, modify them and delete them. The API can be integrated to for example Zoom.
| Task | Student | Estimated time |
|---|---|---|