Scribd
Upload
13 views3 pages

5.9 Building APIs

Uploaded by

Wonder Boy
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
13 views3 pages

5.9 Building APIs

Uploaded by

Wonder Boy
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 3

Building APIs 1

Building APIs
Terms
API endpoint HTTP status codes
Data validation libraries Postman
HTTP methods Route handlers

Summary
• To build APIs, we add a route le (route.tsx) in a directory. Note that within a single
directory, we can either have a page or a route le but not both.

• In route les, we add one or more route handlers. A route handler is a function that
handles an HTTP request.

• HTTP requests have a method which can be GET (for getting data), POST (for creating
data), PUT/PATCH (for updating data), and DELETE (for deleting data).

• HTTP protocol de nes standard status codes for different situations. A few commonly
used ones include: 200 (for success), 201 (when a resource is created), 400 (indicating a
bad request), 404 (if something is not found), and 500 (for internal server errors).

• To create an object, the client should send a POST request to an API endpoint and
include the object in the body of the request.

• We should always validate objects sent by clients. We can validate objects using simple
if statements but as our applications get more complex, we may end up with complex
and nested if statements.

Copyright 2023 Code with Mosh codewithmosh.com


fi
fi
fi
fi
Building APIs 2

• Data validation libraries, such as Zod, allow us to de ne the structure of our objects
using a simple syntax, taking care of all the complexity involved in data validation.

• To update an object, the client should send a PUT or PATCH request to an API endpoint
and include the object in the request body. PUT and PATCH are often used
interchangeably. However, PUT is intended for replacing objects, while PATCH is
intended for updating one or more properties.

• To delete an object, the client should send a DELETE request to an API endpoint. The
request body should be empty.

• We can use Postman for testing APIs. With Postman we can easily send HTTP requests
to API endpoints and inspect the responses.

Copyright 2023 Code with Mosh codewithmosh.com


fi
Building APIs 3

Creating Route Handlers

Copyright 2023 Code with Mosh codewithmosh.com

You might also like