Web services project for course IT 325 Web services
This is a Web Service project built using the following stack:
TypeScript |
Fastify |
Prisma |
PostgreSQL |
It uses other technologies such as:
Swagger |
JSON Web Tokens |
Zod |
Faker |
🏠 Homepage
npm installnpm run startnpm run devstart: Start the production serverdev: Start the development servermig: Run Prisma migrationsgen: Generate Prisma clientstudio: Start Prisma Studiofaker: Generate fake data using Faker
To check the Swagger documentation for this project's API, follow these steps:
- Start the development server:
npm run dev- Navigate to the Swagger documentation page in your web browser:
http://localhost:<insert your port from .env file here>/documentation
You should see a page that displays the documentation for all of the available API endpoints. You can use the Swagger documentation to try out different API requests and see the responses that they return.
In addition to generating API documentation, Swagger also provides several other features that you may find useful. For example, you can use Swagger to:
- Validate the requests and responses sent to and from the server
- Automatically generate code for your API client
- Integrate with other API development tools, such as Postman
To learn more about what Swagger can do for you, check out the Swagger website.
👤 Rayen Nasraoui
Give a ⭐️ if this project helped you!
This README was generated with ❤️ by readme-md-generator