Skip to content

Commit 83b91c9

Browse files
committed
Added Next.js BE & FE
1 parent 89293ac commit 83b91c9

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -330,18 +330,21 @@ Here is what it looks like:
330330
### Using the `openapi.yaml` File
331331

332332
1. **View the API Documentation**
333+
333334
- Open [Swagger Editor](https://editor.swagger.io/).
334335
- Upload the `openapi.yaml` file or paste its content.
335336
- Visualize and interact with the API documentation.
336337

337338
2. **Test the API**
339+
338340
- Import `openapi.yaml` into [Postman](https://www.postman.com/):
339341
- Open Postman → Import → Select `openapi.yaml`.
340342
- Test the API endpoints directly from Postman.
341343
- Or use [Swagger UI](https://swagger.io/tools/swagger-ui/):
342344
- Provide the file URL or upload it to view and test endpoints.
343345

344346
3. **Generate Client Libraries**
347+
345348
- Install OpenAPI Generator:
346349
```bash
347350
npm install @openapitools/openapi-generator-cli -g
@@ -353,13 +356,15 @@ Here is what it looks like:
353356
- Replace `<language>` with the desired programming language.
354357

355358
4. **Generate Server Stubs**
359+
356360
- Generate a server stub:
357361
```bash
358362
openapi-generator-cli generate -i openapi.yaml -g <framework> -o ./server
359363
```
360364
- Replace `<framework>` with the desired framework.
361365

362366
5. **Run a Mock Server**
367+
363368
- Install Prism:
364369
```bash
365370
npm install -g @stoplight/prism-cli
@@ -370,6 +375,7 @@ Here is what it looks like:
370375
```
371376

372377
6. **Validate the OpenAPI File**
378+
373379
- Use [Swagger Validator](https://validator.swagger.io/):
374380
- Upload `openapi.yaml` or paste its content to check for errors.
375381

src/app/landing/page.tsx

+4-1
Original file line numberDiff line numberDiff line change
@@ -627,7 +627,10 @@ export default function LandingPage() {
627627
Visit the app&apos;s source code repository and view the API
628628
documentation to get to know the app even better!
629629
</Typography>
630-
<Link href="https://github.com/hoangsonww/ToDo-App-NextJS-Fullstack" passHref>
630+
<Link
631+
href="https://github.com/hoangsonww/ToDo-App-NextJS-Fullstack"
632+
passHref
633+
>
631634
<Button
632635
variant="contained"
633636
sx={{

src/app/page.tsx

+5-2
Original file line numberDiff line numberDiff line change
@@ -621,13 +621,16 @@ export default function LandingPage() {
621621
}}
622622
>
623623
<Typography variant="h5" gutterBottom>
624-
Explore the App&apos;s Documentation
624+
Explore the App&apos;s Documentation
625625
</Typography>
626626
<Typography variant="body2" gutterBottom>
627627
Visit the app&apos;s source code repository and view the API
628628
documentation to get to know the app even better!
629629
</Typography>
630-
<Link href="https://github.com/hoangsonww/ToDo-App-NextJS-Fullstack" passHref>
630+
<Link
631+
href="https://github.com/hoangsonww/ToDo-App-NextJS-Fullstack"
632+
passHref
633+
>
631634
<Button
632635
variant="contained"
633636
sx={{

0 commit comments

Comments
 (0)