Skip to content

Commit 6092f68

Browse files
committed
feat: replace Postman collection with REST Client .rest file (#495)
- Add rest/players.rest with health check and full CRUD requests - Add humao.rest-client to .vscode/extensions.json recommendations - Replace postman-collections/ with rest/ in .dockerignore - Add rest/ to .prettierignore - Update README.md and CHANGELOG.md
1 parent 95b6daf commit 6092f68

File tree

7 files changed

+317
-127
lines changed

7 files changed

+317
-127
lines changed

.dockerignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
coverage/
44
dist/
55
node_modules/
6-
postman-collections/
6+
rest/
77
tests/
88
.codeclimate.yml
99
.env

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
tests/player-test.ts
2+
rest/

.vscode/extensions.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
// Testing
1313
"orta.vscode-jest", // Jest - JavaScript testing framework
14+
"humao.rest-client", // REST Client - Send HTTP requests from .rest files
1415

1516
// Formatting & Language Support
1617
"redhat.vscode-xml", // XML Language Support - XML language server

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,17 @@ This project uses football/soccer terminology for release names:
4444

4545
### Added
4646

47+
- `rest/players.rest` HTTP file with health check, POST, GET (all, by ID, by squad number), PUT, and DELETE requests for VS Code REST Client (`humao.rest-client`)
48+
- `humao.rest-client` added to `.vscode/extensions.json` recommended extensions
49+
4750
### Changed
4851

4952
### Deprecated
5053

5154
### Removed
5255

56+
- `postman-collections/` directory and Postman JSON collection replaced by `rest/players.rest`
57+
5358
### Fixed
5459

5560
### Security

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Proof of Concept for a RESTful API made with [Node.js](https://nodejs.org/) [LTS
2929
## Features
3030

3131
- 🏗️ **Modern TypeScript architecture** - Native ESM, strict mode, layered architecture with interface-based contracts
32-
- 📚 **Interactive API exploration** - Auto-generated OpenAPI docs with Swagger UI and Postman collection
32+
- 📚 **Interactive API exploration** - Auto-generated OpenAPI docs with Swagger UI and `.rest` HTTP file for VS Code REST Client
3333
-**Performance optimizations** - In-memory caching with node-cache, Sequelize ORM, and efficient SQLite operations
3434
- 🧪 **Comprehensive integration tests** - Full endpoint coverage with Jest/Supertest and automated reporting to Codecov
3535
- 📖 **Token-efficient documentation** - AGENTS.md + auto-loaded Copilot instructions for AI-assisted development
@@ -70,6 +70,7 @@ src/
7070
├── docs/ # Swagger configuration & doc generation
7171
└── middlewares/ # Custom middleware (swagger CSP)
7272
73+
rest/ # HTTP request files for VS Code REST Client
7374
tests/ # Integration tests with supertest
7475
scripts/ # Docker entrypoint & healthcheck scripts
7576
storage/ # Pre-seeded SQLite database
@@ -164,6 +165,8 @@ Interactive API documentation is available via Swagger UI at `http://localhost:9
164165

165166
For complete endpoint documentation with request/response schemas, explore the [interactive Swagger UI](http://localhost:9000/swagger/). You can also access the OpenAPI JSON specification at `http://localhost:9000/swagger.json`.
166167

168+
Alternatively, use [`rest/players.rest`](rest/players.rest) with the [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) extension for VS Code to send requests directly from the editor.
169+
167170
## Prerequisites
168171

169172
Before you begin, ensure you have the following installed:

postman-collections/ts-node-samples-express-restful.postman_collection.json

Lines changed: 0 additions & 125 deletions
This file was deleted.

0 commit comments

Comments
 (0)