Adds ByteByteGo guides and links (#106)

This PR adds all the guides from [Visual
Guides](https://bytebytego.com/guides/) section on bytebytego to the
repository with proper links.

- [x] Markdown files for guides and categories are placed inside
`data/guides` and `data/categories`
- [x] Guide links in readme are auto-generated using
`scripts/readme.ts`. Everytime you run the script `npm run
update-readme`, it reads the categories and guides from the above
mentioned folders, generate production links for guides and categories
and populate the table of content in the readme. This ensures that any
future guides and categories will automatically get added to the readme.
- [x] Sorting inside the readme matches the actual category and guides
sorting on production
This commit is contained in:
Kamran Ahmed
2025-04-01 06:16:44 +01:00
committed by GitHub
parent 44f1251199
commit ee4b7305a2
493 changed files with 15791 additions and 1728 deletions

View File

@@ -0,0 +1,18 @@
---
title: 'How to Design Effective and Safe APIs'
description: 'Learn how to design effective and safe APIs with best practices.'
image: 'https://assets.bytebytego.com/diagrams/0180-effective-apis.jpeg'
createdAt: '2024-03-05'
draft: false
categories:
- api-web-development
tags:
- API Design
- Software Engineering
---
![](https://assets.bytebytego.com/diagrams/0180-effective-apis.jpeg)
The diagram above shows typical API designs with a shopping cart example.
Note that API design is not just URL path design. Most of the time, we need to choose the proper resource names, identifiers, and path patterns. It is equally important to design proper HTTP header fields or to design effective rate-limiting rules within the API gateway.