base on Hospital Management API built in Spring Boot # Hospital Management - API Module  ## About the project Hospital Management API built in Spring Boot ### Prerequisites: - Spring Boot 3.2.1 - JDK 17 - Maven 4.0.0 ### Running the application 1. `git clone https://github.com/MirnaGama/hospital-management-api/` 2. `cd hospital-management-api` 3. `mvn clean install`<br> It will build the jar file in the target folder 4. `mvn spring-boot:run`<br> It will compile and run the application on default port (8080) ### Running tests - `mvn test`<br> It will executes all the tests. - `mvn -Dtest=packageName.className test`<br> It will execute only one test class - `mvn -Dtest=packageName.className#methodName test`<br> It will run only one test method from one test class ### Features - v1.0 - [X] R1 - Doctor Registration - [X] R2 - List of Doctors - [X] R3 - Doctor Update - [X] R4 - Doctor Exclusion - [X] R5 - Patient Registration - [X] R6 - List of Patients - [X] R7 - Patient Update - [X] R8 - Patient Exclusion - [X] R9 - Consultation Scheduling - [X] R10 - Consultation Cancellation ## API Documentation - /swagger-ui/index.html ### authentication #### POST - [**/api/auth/register**] - Register a new user - **Body:** ``` { "login" (string, required), "password" (string, required), } ``` - **Responses:** | Code | Description | | ------------- | ------------- | | `200` | _Successful operation_ | | `400` | _Validation Error_ | #### POST - [**/api/auth/login**] - Perform the login - **Body:** ``` { "login" (string, required), "password" (string, required), } ``` - **Responses:** | Code | Description | | ------------- | ------------- | | `200` | _Successful operation_ | | `400` | _Validation Error_ | | `403` | _Incorrect credentials_ | ### doctors #### POST - [**/api/v1.0/doctors**] - Adds a new doctor - **Body:** ``` { "name" (string, required), "email" (string, required), "crm" (string, required), "telephone" (string, required), "specialty" (string, required), "address": { "street" (string, required), "neighborhood" (string, required), "zipCode" (string, required), "city" (string, required), "state" (string, required), "additionalDetails" (string, optional), "houseNumber" (string, optional) } } ``` - **Request Headers:** | Key | Description | | ------------- | ------------- | | `Authorization` | _Authorization token_ | - **Responses:** | Code | Description | | ------------- | ------------- | | `201` | _Successfully created_ | | `400` | _Validation Error_ | | `403` | _Unauthorized / Invalid token_ | #### GET - [**/api/v1.0/doctors/{id}**] - Get an existing doctor - **Response Body Example:** ``` { "id": 1, "name": "DOCTOR TEST", "email": "[email protected]", "crm": "12456", "telephone": "(81) 99999999", "specialty": "ORTHOPEDICS", "active": true, "address": { "street": "TEST STR.", "neighborhood": "TEST NEIGHBORHOOD", "zipCode": "12345678", "city": "TEST CITY", "state": "ST", "additionalDetails": null, "houseNumber": null } } ``` - **Request Headers:** | Key | Description | | ------------- | ------------- | | `Authorization` | _Authorization token_ | - **Request Parameters:** | Key | Description | | ------------- | ------------- | | `id` | _Unique identifier of the doctor who will be fetched_ | - **Responses:** | Code | Description | | ------------- | ------------- | | `200` | _Successful operation_ | | `404` | _Entity not found_ | | `403` | _Unauthorized / Invalid token_ | #### GET - [**/api/v1.0/doctors**] - Get a list of doctors - **Response Body Example:** ``` { "content": [ { "name": "Test1", "email": "[email protected]", "crm": "123456", "specialty": "ORTHOPEDICS" }, { "name": "Test2", "email": "[email protected]", "crm": "789101", "specialty": "ORTHOPEDICS" }, { "name": "Test3", "email": "[email protected]", "crm": "112131", "specialty": "ORTHOPEDICS" }, ], "pageable": { "pageNumber": 0, "pageSize": 10, "sort": { "sorted": true, "unsorted": false, "empty": false }, "offset": 0, "paged": true, "unpaged": false }, "totalPages": 1, "totalElements": 3, "last": true, "sort": { "sorted": true, "unsorted": false, "empty": false }, "number": 0, "size": 10, "first": true, "numberOfElements": 3, "empty": false } ``` - **Request Headers:** | Key | Description | | ------------- | ------------- | | `Authorization` | _Authorization token_ | - **Request Parameters:** | Key | Description | | ------------- | ------------- | | `size` | _Number of records that should be returned_ | | `sort` | _Sort by object attribute in descending order_ | | `page` | _Page number_ | - **Responses:** | Code | Description | | ------------- | ------------- | | `200` | _Successful operation_ | | `403` | _Unauthorized / Invalid token_ | #### PUT - [**/api/v1.0/doctors**] - Updates an existing doctor - **Body:** ``` { "id" (number, required), "name" (string, optional), "telephone" (string, optional), "address": { "street" (string, optional), "neighborhood" (string, optional), "zipcode" (string, optional), "city" (string, optional), "state" (string, optional), "additionalDetails" (string, optional), "houseNumber" (string, optional), } } ``` - **Request Headers:** | Key | Description | | ------------- | ------------- | | `Authorization` | _Authorization token_ | - **Responses:** | Code | Description | | ------------- | ------------- | | `200` | _Successful operation_ | | `400` | _Validation Error_ | | `403` | _Unauthorized / Invalid token_ | #### DELETE - [**/api/v1.0/doctors/{id}**] - Deactivates an existing doctor - **Response Body Example:** ``` { "id": 2, "name": "DEACTIVATED DOCTOR TEST", "email": "[email protected]", "crm": "12456", "telephone": "(81) 99999999", "specialty": "ORTHOPEDICS", "active": false, "address": { "street": "TEST STR.", "neighborhood": "TEST NEIGHBORHOOD", "zipCode": "12345678", "city": "TEST CITY", "state": "ST", "additionalDetails": null, "houseNumber": null } } ``` - **Request Headers:** | Key | Description | | ------------- | ------------- | | `Authorization` | _Authorization token_ | - **Request Parameters:** | Key | Description | | ------------- | ------------- | | `id` | _Unique identifier of the doctor who will be deactivated_ | - **Responses:** | Code | Description | | ------------- | ------------- | | `200` | _Successful operation_ | | `400` | _Validation Error_ | | `404` | _Entity not found_ | | `403` | _Unauthorized / Invalid token_ | ### patients #### POST - [**/api/v1.0/patients**] - Adds a new patient - **Body:** ``` { "name" (string, required), "email" (string, required), "cpf" (string, required), "telephone" (string, required), "address": { "street" (string, required), "neighborhood" (string, required), "zipCode" (string, required), "city" (string, required), "state" (string, required), "additionalDetails" (string, optional), "houseNumber" (string, optional) } } ``` - **Request Headers:** | Key | Description | | ------------- | ------------- | | `Authorization` | _Authorization token_ | - **Responses:** | Code | Description | | ------------- | ------------- | | `201` | _Successfully created_ | | `400` | _Validation Error_ | | `403` | _Unauthorized / Invalid token_ | #### GET - [**/api/v1.0/patients/{id}**] - Get an existing patient - **Response Body Example:** ``` { "id": 1, "name": "PATIENT TEST", "email": "[email protected]", "cpf": "11111111111", "telephone": "(81) 99999999", "active": true, "address": { "street": "TEST STR.", "neighborhood": "TEST NEIGHBORHOOD", "zipCode": "12345678", "city": "TEST CITY", "state": "ST", "additionalDetails": null, "houseNumber": null } } ``` - **Request Headers:** | Key | Description | | ------------- | ------------- | | `Authorization` | _Authorization token_ | - **Request Parameters:** | Key | Description | | ------------- | ------------- | | `id` | _Unique identifier of the patient who will be fetched_ | - **Responses:** | Code | Description | | ------------- | ------------- | | `200` | _Successful operation_ | | `404` | _Entity not found_ | | `403` | _Unauthorized / Invalid token_ | #### GET - [**/api/v1.0/patients**] - Get a list of patients - **Response Body Example:** ``` { "content": [ { "name": "Test1", "email": "[email protected]", "cpf": "123456" }, { "name": "Test2", "email": "[email protected]", "cpf": "789101" }, { "name": "Test3", "email": "[email protected]", "cpf": "112131" }, ], "pageable": { "pageNumber": 0, "pageSize": 10, "sort": { "sorted": true, "unsorted": false, "empty": false }, "offset": 0, "paged": true, "unpaged": false }, "totalPages": 1, "totalElements": 3, "last": true, "sort": { "sorted": true, "unsorted": false, "empty": false }, "number": 0, "size": 10, "first": true, "numberOfElements": 3, "empty": false } ``` - **Request Headers:** | Key | Description | | ------------- | ------------- | | `Authorization` | _Authorization token_ | - **Request Parameters:** | Key | Description | | ------------- | ------------- | | `size` | _Number of records that should be returned_ | | `sort` | _Sort by object attribute in descending order_ | | `page` | _Page number_ | - **Responses:** | Code | Description | | ------------- | ------------- | | `200` | _Successful operation_ | | `403` | _Unauthorized / Invalid token_ | #### PUT - [**/api/v1.0/patients**] - Updates an existing patient - **Body:** ``` { "id" (number, required), "name" (string, optional), "telephone" (string, optional), "address": { "street" (string, optional), "neighborhood" (string, optional), "zipcode" (string, optional), "city" (string, optional), "state" (string, optional), "additionalDetails" (string, optional), "houseNumber" (string, optional), } } ``` - **Request Headers:** | Key | Description | | ------------- | ------------- | | `Authorization` | _Authorization token_ | - **Responses:** | Code | Description | | ------------- | ------------- | | `200` | _Successful operation_ | | `400` | _Validation Error_ | | `403` | _Unauthorized / Invalid token_ | #### DELETE - [**/api/v1.0/patients/{id}**] - Deactivates an existing patient - **Response Body Example:** ``` { "id": 1, "name": "DEACTIVATED PATIENT TEST", "email": "[email protected]", "cpf": "11111111111", "telephone": "(81) 99999999", "active": false, "address": { "street": "TEST STR.", "neighborhood": "TEST NEIGHBORHOOD", "zipCode": "12345678", "city": "TEST CITY", "state": "ST", "additionalDetails": null, "houseNumber": null } } ``` - **Request Headers:** | Key | Description | | ------------- | ------------- | | `Authorization` | _Authorization token_ | - **Request Parameters:** | Key | Description | | ------------- | ------------- | | `id` | _Unique identifier of the patient who will be deactivated_ | - **Responses:** | Code | Description | | ------------- | ------------- | | `200` | _Successful operation_ | | `400` | _Validation Error_ | | `404` | _Entity not found_ | | `403` | _Unauthorized / Invalid token_ | ### consultations #### POST - [**/api/v1.0/consultations**] - Adds a new consultation - **Body:** ``` { "patientId" (number, required), "consultationDate" (string, required), "doctorId" (number, required if _specialty_ field is not filled), "specialty" (string, required if _doctorId_ field is not filled) } ``` - **Request Headers:** | Key | Description | | ------------- | ------------- | | `Authorization` | _Authorization token_ | - **Responses:** | Code | Description | | ------------- | ------------- | | `201` | _Successfully created_ | | `400` | _Validation Error_ | | `403` | _Unauthorized / Invalid token_ | | `404` | _Entity not found_ | #### GET - [**/api/v1.0/consultations/{id}**] - Get an existing consultation - **Response Body Example:** ``` { "id": 1, "consultationDate": "22/04/2024 10:34", "patient": {...}, "doctor": {...}, "canceled": false, "reasonCancellation: "" } ``` - **Request Headers:** | Key | Description | | ------------- | ------------- | | `Authorization` | _Authorization token_ | - **Request Parameters:** | Key | Description | | ------------- | ------------- | | `id` | _Unique identifier of the consultation that will be fetched_ | - **Responses:** | Code | Description | | ------------- | ------------- | | `200` | _Successful operation_ | | `404` | _Entity not found_ | | `403` | _Unauthorized / Invalid token_ | #### DELETE - [**/api/v1.0/consultations**] - Cancels a scheduled consultation - **Body:** ``` { "consultationId" (number, required), "reasonCancellation" (string, required), } ``` - **Request Headers:** | Key | Description | | ------------- | ------------- | | `Authorization` | _Authorization token_ | - **Responses:** | Code | Description | | ------------- | ------------- | | `200` | _Successful operation_ | | `403` | _Unauthorized / Invalid token_ | | `404` | _Entity not found_ | ", Assign "at most 3 tags" to the expected json: {"id":"7522","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"