[{"_1":2,"_153":-5,"_154":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_132":133},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":131},"canonicalUrl","https://hub.docker.com/r/gustosilva/dynamodb-api/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","gustosilva","reponame","dynamodb-api","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2022-12-06T16:54:17.740338Z","description","API feita para testar a integração do Spring boot com o AWS DynamoDB","is_private","last_updated","2023-02-28T01:01:45.323665Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",23404,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# dynamoDB-API \n\nAPI feita para testar a integração do Spring boot com o AWS DynamoDB.\n\n## Tabela de Conteúdos \n\n- [Features](#features)\n- [Contrato da API](#contrato-da-api)\n- [Endpoints da Aplicação](#endpoints-da-aplicação)\n - [/employee](#employee)\n - [POST](#post)\n - [Summary:](#summary)\n - [Description:](#description)\n - [Parameters](#parameters)\n - [Responses](#responses)\n - [/employee/{id}](#employeeid)\n - [GET](#get)\n - [Summary:](#summary-1)\n - [Description:](#description-1)\n - [Parameters](#parameters-1)\n - [Responses](#responses-1)\n - [PUT](#put)\n - [Summary:](#summary-2)\n - [Description:](#description-2)\n - [Parameters](#parameters-2)\n - [Responses](#responses-2)\n - [DELETE](#delete)\n - [Summary:](#summary-3)\n - [Description:](#description-3)\n - [Parameters](#parameters-3)\n - [Responses](#responses-3)\n - [Models](#models)\n - [Department](#department)\n - [Employee](#employee-1)\n - [EmployeeDto](#employeedto)\n - [EmployeeInput](#employeeinput)\n- [Pré-requisitos e como rodar a aplicação/testes](#pré-requisitos-e-como-rodar-a-aplicaçãotestes)\n - [Tecnologias utilizadas](#tecnologias-utilizadas)\n - [Dependencias](#dependencias)\n - [Licença](#licença)\n - [Autor](#autor)\n\n \n## Features\n\n- [x] Cadastro de dados de funcionários e seus respectivos departamentos\n\n- [x] Consulta de dados de funcionários e seus respectivos departamentos\n\n- [x] Atualização de dados de funcionários e seus respectivos departamentos\n\n- [x] Exclusão de dados de funcionários e seus respectivos departamentos\n\n## Contrato da API\n\n```json\n{\n \"swagger\": \"2.0\",\n \"info\": {\n \"description\": \"API using Spring Boot for dynamoDB testing\",\n \"version\": \"1.0.0\",\n \"title\": \"DynamoDB API\",\n \"license\": {\n \"name\": \"Apache License Version 2.0\",\n \"url\": \"https://www.apache.org/licenses/LICENSE-2.0\"\n }\n },\n \"host\": \"localhost:8080\",\n \"basePath\": \"/\",\n \"tags\": [\n {\n \"name\": \"employee-controller\",\n \"description\": \"Employee Controller\"\n }\n ],\n \"paths\": {\n \"/employee\": {\n \"post\": {\n \"tags\": [\n \"employee-controller\"\n ],\n \"summary\": \"Saves a new employee\",\n \"description\": \"Saves a new employee in dynamoDB\",\n \"operationId\": \"saveEmployeeUsingPOST\",\n \"consumes\": [\n \"application/json\"\n ],\n \"produces\": [\n \"*/*\"\n ],\n \"parameters\": [\n {\n \"in\": \"body\",\n \"name\": \"employee\",\n \"description\": \"Form for creation of user\",\n \"required\": true,\n \"schema\": {\n \"$ref\": \"#/definitions/EmployeeInput\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"OK\",\n \"schema\": {\n \"$ref\": \"#/definitions/Employee\"\n }\n },\n \"201\": {\n \"description\": \"Created\"\n },\n \"401\": {\n \"description\": \"Unauthorized\"\n },\n \"403\": {\n \"description\": \"Forbidden\"\n },\n \"404\": {\n \"description\": \"Not Found\"\n }\n },\n \"deprecated\": false\n }\n },\n \"/employee/{id}\": {\n \"get\": {\n \"tags\": [\n \"employee-controller\"\n ],\n \"summary\": \"Get data of specific employee\",\n \"description\": \"Get data of specific employee in dynamoDB\",\n \"operationId\": \"getEmployeeUsingGET\",\n \"produces\": [\n \"*/*\"\n ],\n \"parameters\": [\n {\n \"name\": \"id\",\n \"in\": \"path\",\n \"description\": \"Employee id\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"OK\",\n \"schema\": {\n \"$ref\": \"#/definitions/EmployeeDto\"\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\"\n },\n \"403\": {\n \"description\": \"Forbidden\"\n },\n \"404\": {\n \"description\": \"Not Found\"\n }\n },\n \"deprecated\": false\n },\n \"put\": {\n \"tags\": [\n \"employee-controller\"\n ],\n \"summary\": \"Update data of specific employee\",\n \"description\": \"Update data of specific employee in dynamoDB\",\n \"operationId\": \"updateEmployeeUsingPUT\",\n \"consumes\": [\n \"application/json\"\n ],\n \"produces\": [\n \"*/*\"\n ],\n \"parameters\": [\n {\n \"in\": \"body\",\n \"name\": \"employee\",\n \"description\": \"Form to update user\",\n \"required\": true,\n \"schema\": {\n \"$ref\": \"#/definitions/EmployeeInput\"\n }\n },\n {\n \"name\": \"id\",\n \"in\": \"path\",\n \"description\": \"Employee id\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"OK\",\n \"schema\": {\n \"$ref\": \"#/definitions/EmployeeDto\"\n }\n },\n \"201\": {\n \"description\": \"Created\"\n },\n \"401\": {\n \"description\": \"Unauthorized\"\n },\n \"403\": {\n \"description\": \"Forbidden\"\n },\n \"404\": {\n \"description\": \"Not Found\"\n }\n },\n \"deprecated\": false\n },\n \"delete\": {\n \"tags\": [\n \"employee-controller\"\n ],\n \"summary\": \"Deletes specific employee\",\n \"description\": \"Deletes employee in dynamoDB\",\n \"operationId\": \"deleteEmployeeUsingDELETE\",\n \"produces\": [\n \"*/*\"\n ],\n \"parameters\": [\n {\n \"name\": \"id\",\n \"in\": \"path\",\n \"description\": \"Employee id\",\n \"required\": true,\n \"type\": \"string\"\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"OK\"\n },\n \"204\": {\n \"description\": \"No Content\"\n },\n \"401\": {\n \"description\": \"Unauthorized\"\n },\n \"403\": {\n \"description\": \"Forbidden\"\n }\n },\n \"deprecated\": false\n }\n }\n },\n \"definitions\": {\n \"Department\": {\n \"type\": \"object\",\n \"properties\": {\n \"departmentCode\": {\n \"type\": \"string\"\n },\n \"departmentName\": {\n \"type\": \"string\"\n }\n },\n \"title\": \"Department\"\n },\n \"Employee\": {\n \"type\": \"object\",\n \"properties\": {\n \"department\": {\n \"$ref\": \"#/definitions/Department\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"employeeId\": {\n \"type\": \"string\"\n },\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n }\n },\n \"title\": \"Employee\"\n },\n \"EmployeeDto\": {\n \"type\": \"object\",\n \"properties\": {\n \"departamentCode\": {\n \"type\": \"string\"\n },\n \"departamentName\": {\n \"type\": \"string\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n }\n },\n \"title\": \"EmployeeDto\"\n },\n \"EmployeeInput\": {\n \"type\": \"object\",\n \"properties\": {\n \"department\": {\n \"$ref\": \"#/definitions/Department\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"employeeId\": {\n \"type\": \"string\"\n },\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n }\n },\n \"title\": \"EmployeeInput\"\n }\n }\n}\n```\n\n## Endpoints da Aplicação\n\n### /employee\n\n#### POST\n\n##### Summary:\n\nSaves a new employee\n\n##### Description:\n\nSaves a new employee in dynamoDB\n\n##### Parameters\n\n| Name | Located in | Description | Required | Schema |\n|----------|------------|---------------------------|----------|---------------------------------|\n| employee | body | Form for creation of user | Yes | [EmployeeInput](#EmployeeInput) |\n\n##### Responses\n\n| Code | Description | Schema |\n|------|--------------|-----------------------|\n| 200 | OK | [Employee](#Employee) |\n| 201 | Created | |\n| 401 | Unauthorized | |\n| 403 | Forbidden | |\n| 404 | Not Found | |\n\n### /employee/{id}\n\n#### GET\n\n##### Summary:\n\nGet data of specific employee\n\n##### Description:\n\nGet data of specific employee in dynamoDB\n\n##### Parameters\n\n| Name | Located in | Description | Required | Schema |\n|------|------------|-------------|----------|--------|\n| id | path | Employee id | Yes | string |\n\n##### Responses\n\n| Code | Description | Schema |\n|------|--------------|-----------------------------|\n| 200 | OK | [EmployeeDto](#EmployeeDto) |\n| 401 | Unauthorized | |\n| 403 | Forbidden | |\n| 404 | Not Found | |\n\n#### PUT\n\n##### Summary:\n\nUpdate data of specific employee\n\n##### Description:\n\nUpdate data of specific employee in dynamoDB\n\n##### Parameters\n\n| Name | Located in | Description | Required | Schema |\n|----------|------------|---------------------|----------|---------------------------------|\n| employee | body | Form to update user | Yes | [EmployeeInput](#EmployeeInput) |\n| id | path | Employee id | Yes | string |\n\n##### Responses\n\n| Code | Description | Schema |\n|------|--------------|-----------------------------|\n| 200 | OK | [EmployeeDto](#EmployeeDto) |\n| 201 | Created | |\n| 401 | Unauthorized | |\n| 403 | Forbidden | |\n| 404 | Not Found | |\n\n#### DELETE\n\n##### Summary:\n\nDeletes specific employee\n\n##### Description:\n\nDeletes employee in dynamoDB\n\n##### Parameters\n\n| Name | Located in | Description | Required | Schema |\n|------|------------|-------------|----------|--------|\n| id | path | Employee id | Yes | string |\n\n##### Responses\n\n| Code | Description |\n|------|--------------|\n| 200 | OK |\n| 204 | No Content |\n| 401 | Unauthorized |\n| 403 | Forbidden |\n\n### Models\n\n#### Department\n\n| Name | Type | Description | Required |\n|----------------|--------|-------------|----------|\n| departmentCode | string | | No |\n| departmentName | string | | No |\n\n#### Employee\n\n| Name | Type | Description | Required |\n|------------|---------------------------|-------------|----------|\n| department | [Department](#Department) | | No |\n| email | string | | No |\n| employeeId | string | | No |\n| firstName | string | | No |\n| lastName | string | | No |\n\n#### EmployeeDto\n\n| Name | Type | Description | Required |\n|-----------------|--------|-------------|----------|\n| departamentCode | string | | No |\n| departamentName | string | | No |\n| email | string | | No |\n| firstName | string | | No |\n| lastName | string | | No |\n\n#### EmployeeInput\n\n| Name | Type | Description | Required |\n|------------|---------------------------|-------------|----------|\n| department | [Department](#Department) | | No |\n| email | string | | No |\n| employeeId | string | | No |\n| firstName | string | | No |\n| lastName | string | | No |\n\nColeção para testar os endpoints da aplicação\n\n[![Run in Insomnia}](https://insomnia.rest/images/run.svg)](https://insomnia.rest/run/?label=dynamoDB-API&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fgasfgrv%2FdynamoDB-api%2Fmaster%2FdynamoDB-API-collection.json)\n\n## Pré-requisitos e como rodar a aplicação/testes\n\nPré-requisitos para rodar localmente:\n\n* JDK 11 ou superior\n* Maven 3\n* Uma conta na AWS com uma tabela chamada empoyee no dynamoDB\n * Um usuário com as permissões (de preferencia a de full access ao bd)\n\nPara rodar via docker, rode os comandos abaixo:\n\n```bash\n# Baixar a imagem\ndocker pull gustosilva/dynamodb-api:latest\n\n# Gerar o containter\ndocker run \\\n --env ACCESS_KEY= \\\n --env SECRET_KEY= \\\n --env SERVICE_ENDPOINT= \\\n --env SIGNING_REGION= \\\n -p 8080:8080 gustosilva/dynamodb-api:latest\n```\n\n### Tecnologias utilizadas\n\nProjeto feito usando **Java 11** e **Maven 3.8** como ferramenta de build.\n\n### Dependencias\n\n- spring validation\n- spring web\n- lombok\n- spring test\n- spring cache\n- modelmapper\n- aws-java-sdk-dynamodb\n- springfox-swagger2\n- springfox-swagger-ui\n\n### Licença\n\n[Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)\n\n### Autor\n\n

\n $\"\"/$ \n

Feito por Gustavo Silva:

\n
\n

\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",722704657,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_97":98,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},"content_type","creator",13051238,"digest","sha256:92f4fde343289e4768bc24ce41e7a3a6a3b5cd15c2471e6945daf2f3ea7d16bd","full_size",370200459,"id",343458770,"images",[99],{"_100":101,"_91":92,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":94,"_59":62,"_113":-5},"architecture","amd64","features","","last_pulled","2026-09-20T02:50:31.632710224Z","last_pushed","2023-02-28T01:01:46Z","os","linux","os_features","os_version","size","variant","2023-02-28T01:01:45.098039Z","last_updater","last_updater_username","media_type","latest","repository",18716658,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":134,"_141":142,"_130":151,"_152":11},{"_36":135,"_38":136,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":137,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":138,"_75":11,"_76":140,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":139},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_143":60,"_144":-5,"_145":-5,"_146":147},"count","next","previous","results",[148],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_97":149,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},[150],{"_100":101,"_91":92,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":94,"_59":62,"_113":-5},[],"canDeleteTags","actionData","errors"]

gustosilva/dynamodb-api

Tags for gustosilva/dynamodb-api