{"id":742,"date":"2016-04-25T06:10:41","date_gmt":"2016-04-25T09:10:41","guid":{"rendered":"https:\/\/www.semeru.com.br\/blog\/?p=742"},"modified":"2022-12-21T10:59:35","modified_gmt":"2022-12-21T13:59:35","slug":"criando-o-primeiro-endpoint-rest-com-springboot","status":"publish","type":"post","link":"https:\/\/www.semeru.com.br\/blog\/criando-o-primeiro-endpoint-rest-com-springboot\/","title":{"rendered":"Criando o primeiro endpoint REST com SpringBoot"},"content":{"rendered":"

Neste post daremos continuidade a uma s\u00e9rie de postagens sobre Web-Services<\/strong> divididos entre conceitos te\u00f3ricos e praticos. Nos 3 primeiros posts focou-se em teoria com um sobre Web Services<\/a>, outro sobre RESTful Web Services<\/a> e mais um sobre os HTTP Status Codes<\/a> mais comuns. Este post por sua vez complementa o que foi desenvolvido no post Do zero ao REST em 5 minutos com SpringBoot<\/a>. Ent\u00e3o antes de come\u00e7ar veja o post anterior ou baixe o c\u00f3digo e vamos entender na pr\u00e1tica como funcionam os verbos REST<\/strong>.<\/p>\n

Agora faremos algumas altera\u00e7\u00f5es no projeto desenvolvido no post anterior. Para come\u00e7ar crie os seguintes pacotes br.com.erudio.models<\/strong>, br.com.erudio.services<\/strong>, br.com.erudio.services.implementations<\/strong> e br.com.erudio.web.controllers<\/strong>. Depois mova a classe Greeting<\/strong> para o pacote br.com.erudio.models<\/strong> e a classe GreetingController<\/strong> para o pacote br.com.erudio.web.controllers<\/strong>. A estrutura de pacotes deve ficar similar a imagem abaixo.<\/p>\n

\"postagem_2_0\"<\/a><\/p>\n

Feito isto crie uma classe chamada Person<\/strong>, no pacote br.com.erudio.models<\/strong>, com as informa\u00e7\u00f5es que ser\u00e3o representadas pelo nosso endpoint REST<\/strong>.<\/p>\n

\npackage br.com.erudio.models;\n\nimport java.io.Serializable;\n\nimport com.fasterxml.jackson.annotation.JsonIgnoreProperties;\n\n@JsonIgnoreProperties(ignoreUnknown = true)\npublic class Person implements Serializable{\n\n    private static final long serialVersionUID = 1L;\n\n    private Long id;\n    private String firstName;\n    private String lastName;\n    private String address;\n\n    public Long getId() {\n        return id;\n    }\n\n    public void setId(Long id) {\n        this.id = id;\n    }\n\n    public String getFirstName() {\n        return firstName;\n    }\n\n    public void setFirstName(String firstName) {\n        this.firstName = firstName;\n    }\n\n    public String getLastName() {\n        return lastName;\n    }\n\n    public void setLastName(String lastName) {\n        this.lastName = lastName;\n    }\n\n    public String getAddress() {\n        return address;\n    }\n\n    public void setAddress(String address) {\n        this.address = address;\n    }\n}\n\n<\/pre>\n
 <\/p>\n
Feito isto crie uma interface<\/strong> com o nome PersonService<\/strong> no pacote br.com.erudio.models<\/strong>.<\/p>\n
 <\/p>\n
\npackage br.com.erudio.services;\n\nimport java.util.List;\n\nimport br.com.erudio.models.Person;\n\npublic interface PersonService {\n\n    Person create(final Person person);\n    Person findById(final String personId);\n    List<person> findAll();\n    Person update(Person person);\n    void delete(final String personId);\n\n}\n<\/pre>\n
Agora vamos criar a implementa\u00e7\u00e3o para a interface PersonService<\/strong>. No pacote br.com.erudio.services.implementations<\/strong> crie a classe PersonServiceImpl<\/strong> que implementa a interface que acabamos de criar.<\/p>\n
\npackage br.com.erudio.services.implementations;\n\nimport java.util.ArrayList;\nimport java.util.List;\nimport java.util.concurrent.atomic.AtomicLong;\n\nimport org.springframework.stereotype.Service;\n\nimport br.com.erudio.models.Person;\nimport br.com.erudio.services.PersonService;\n\n@Service\npublic class PersonServiceImpl implements PersonService {\n\n\t\/\/ Contador respons\u00e1vel por gerar um fake ID j\u00e1 que n\u00e3o estamos\n\t\/\/ acessando nenhum banco de dados\n    private final AtomicLong counter = new AtomicLong();\n\n\t\/\/ Metodo respons\u00e1vel por criar uma nova pessoa\n\t\/\/ Se tiv\u00e9ssemos um banco de dados esse seria o\n\t\/\/ momento de persistir os dados\n    @Override\n    public Person create(Person person) {\n        return person;\n    }\n\n\t\/\/ M\u00e9todo respons\u00e1vel por retornar uma pessoa\n\t\/\/ como n\u00e3o acessamos nenhuma base de dados\n\t\/\/ estamos retornando um mock\n    @Override\n    public Person findById(String personId) {\n        Person person = new Person();\n        person.setId(counter.incrementAndGet());\n        person.setFirstName("Leandro");\n        person.setLastName("Costa");\n        person.setAddress("Uberl\u00e2ndia - Minas Gerais - Brasil");\n        return person;\n    }\n\n\t\/\/ M\u00e9todo respons\u00e1vel por retornar todas as pessoas\n\t\/\/ mais uma vez essas informa\u00e7\u00f5es s\u00e3o mocks\n    @Override\n    public List<person> findAll() {\n        ArrayList<person> persons = new ArrayList&lt;&gt;();\n        for (int i = 0; i &lt; 8; i++) {\n            Person person = mockPerson(i);\n            persons.add(person);\n        }\n        return persons;\n    }\n\n\t\/\/ M\u00e9todo respons\u00e1vel por atualizar uma pessoa\n\t\/\/ por ser mock retornamos a mesma informa\u00e7\u00e3o passada\n    @Override\n    public Person update(Person person) {\n    \treturn person;\n    }\n\n\t\/\/ M\u00e9todo respons\u00e1vel por deletar\n\t\/\/ uma pessoa a partir de um ID\n    @Override\n    public void delete(String personId) {\n\n    }\n\n\t\/\/ M\u00e9todo respons\u00e1vel por mockar uma pessoa\n    private Person mockPerson(int i) {\n        Person person = new Person();\n        person.setId(counter.incrementAndGet());\n        person.setFirstName("Person Name " + i);\n        person.setLastName("Last Name " + i);\n        person.setAddress("Some Address in Brasil " + i);\n        return person;\n    }\n}\n\n<\/pre>\n
Por fim crie a classe PersonController<\/strong>, respons\u00e1vel por expor o endpoint de pessoas<\/strong>, no pacote br.com.erudio.web.controllers<\/strong>.<\/p>\n
\npackage br.com.erudio.web.controllers;\n\nimport java.util.List;\n\nimport org.springframework.beans.factory.annotation.Autowired;\nimport org.springframework.http.HttpStatus;\nimport org.springframework.http.MediaType;\nimport org.springframework.web.bind.annotation.PathVariable;\nimport org.springframework.web.bind.annotation.RequestBody;\nimport org.springframework.web.bind.annotation.RequestMapping;\nimport org.springframework.web.bind.annotation.RequestMethod;\nimport org.springframework.web.bind.annotation.ResponseStatus;\nimport org.springframework.web.bind.annotation.RestController;\n\nimport br.com.erudio.models.Person;\nimport br.com.erudio.services.PersonService;\n\n@RestController\n\/\/Mapeia as requisi\u00e7\u00f5es de localhost:8080\/person\/\n@RequestMapping("\/person\/")\npublic class PersonController {\n\n    @Autowired\n    private PersonService personService;\n\n    @ResponseStatus(HttpStatus.OK) \/\/Por padr\u00e3o responde com o status code 200 success\n    @RequestMapping(value = "\/{personId}",\n\t\t\/\/Mapeia as requisi\u00e7\u00f5es GET para localhost:8080\/person\/\n\t\t\/\/recebendo um ID como @PathVariable\n\t\tmethod = RequestMethod.GET,\n\t\tproduces = MediaType.APPLICATION_JSON_VALUE)\n\t\t\/\/ Produz JSON como retorno\n    public Person get(@PathVariable(value = "personId") String personId){\n        return personService.findById(personId);\n    }\n\n    @ResponseStatus(HttpStatus.OK)\n\t\/\/Por padr\u00e3o responde com o status code 200 success\n    @RequestMapping(value = "\/findAll",\n\t\t\/\/Mapeia as requisi\u00e7\u00f5es GET para localhost:8080\/person\/findAll\n\t\tmethod = RequestMethod.GET,\n\t\tproduces = MediaType.APPLICATION_JSON_VALUE)\n\t\t\/\/ Produz JSON como retorno\n    public List<person> findAll(){\n        return personService.findAll();\n    }\n\n    @ResponseStatus(HttpStatus.OK)\n\t\/\/Por padr\u00e3o responde com o status code 200 success\n    @RequestMapping(method = RequestMethod.PUT,\n\t\/\/Mapeia as requisi\u00e7\u00f5es PUT para localhost:8080\/person\/\n\t\tconsumes = MediaType.APPLICATION_JSON_VALUE,\n\t\t\/\/ Consome JSON enviado no corpo da requisi\u00e7\u00e3o\n\t\tproduces = MediaType.APPLICATION_JSON_VALUE)\n\t\t\/\/ Produz JSON como retorno\n    public Person create(@RequestBody Person person){\n        return personService.create(person);\n    }\n\n    @ResponseStatus(HttpStatus.OK)\n\t\/\/Por padr\u00e3o responde com o status code 200 success\n    @RequestMapping(method = RequestMethod.POST,\n\t\/\/Mapeia as requisi\u00e7\u00f5es POST para localhost:8080\/person\/\n\t\tconsumes = MediaType.APPLICATION_JSON_VALUE)\n\t\t\/\/ Consome JSON enviado no corpo da requisi\u00e7\u00e3o\n    public Person update(@RequestBody Person person){\n        return personService.update(person);\n    }\n\n    @ResponseStatus(HttpStatus.OK)\n\t\/\/Por padr\u00e3o responde com o status code 200 success\n    @RequestMapping(value = "\/{personId}",\n\t\tmethod = RequestMethod.DELETE)\n\t\t\/\/Mapeia as requisi\u00e7\u00f5es DELETE para localhost:8080\/person\/\n\t\t\/\/recebendo um ID como @PathVariable\n    public void delete(@PathVariable(value = "personId") String personId){\n        personService.delete(personId);\n    }\n}\n<\/pre>\n
Agora que terminamos nossa codifica\u00e7\u00e3o acesse a classe Application<\/strong> e inicie a aplica\u00e7\u00e3o como no post anterior. Para testar nosso endpoint e cada uma de suas opera\u00e7\u00f5es usaremos o plugin do Chrome Postman<\/a>.<\/p>\n
Primeiro faremos uma requisi\u00e7\u00e3o do tipo GET<\/strong> chamando a opera\u00e7\u00e3o findAll<\/strong> para o recurso localhost:8080\/person\/findAll<\/strong>. Como se pode ver na imagem abaixo obtemos como resposta um JSON<\/strong> com um array de pessoas.<\/p>\n
\"postagem_2_2\"<\/a><\/p>\n
Agora faremos uma requisi\u00e7\u00e3o do tipo GET<\/strong> chamando a opera\u00e7\u00e3o localhost:8080\/person\/1<\/strong> passando como @PathVariable<\/strong> o ID da pessoa que desejamos recuperar. Da mesma forma que na requisi\u00e7\u00e3o anterior recebemos como resposta um JSON<\/strong> com 1 objeto pessoa.<\/p>\n
\"postagem_2_1\"<\/a><\/p>\n
Agora faremos uma requisi\u00e7\u00e3o do tipo POST<\/strong> (esse \u00e9 o verbo REST usado para persistir informa\u00e7\u00f5es)<\/strong> chamando a opera\u00e7\u00e3o localhost:8080\/person\/<\/strong> passando como par\u00e2metro um JSON<\/strong> com um objeto pessoa no corpo da requisi\u00e7\u00e3o. Para isso no Postman<\/strong> precisamos setar o tipo de requisi\u00e7\u00e3o como POST<\/strong>, na aba Body<\/strong> definimos o JSON<\/strong> que representa o objeto pessoa a ser gravado, selecionamos a op\u00e7\u00e3o raw<\/strong>, definimos a op\u00e7\u00e3o JSON(application\/json)<\/strong> e por fim executamos a request atrav\u00e9s do bot\u00e3o send.<\/p>\n
\"postagem_2_3\"<\/a><\/p>\n
Na imagem abaixo podemos ver o body da response retornada com um ID definido pela aplica\u00e7\u00e3o.<\/p>\n
\"postagem_2_4\"<\/a><\/p>\n
Agora faremos uma requisi\u00e7\u00e3o do tipo PUT (esse \u00e9 o verbo REST usado para atualizar informa\u00e7\u00f5es)<\/strong> chamando a opera\u00e7\u00e3o localhost:8080\/person\/<\/strong> passando como par\u00e2metro um JSON<\/strong> com um objeto pessoa no corpo da requisi\u00e7\u00e3o. Lembrando que essa representa\u00e7\u00e3o de pessoa deve ter um ID que ser\u00e1 usado pra localizar e atualizar um recurso na base. Para isso no Postman<\/strong> precisamos setar informa\u00e7\u00f5es similares ao post a unica diferen\u00e7a \u00e9 que o tipo de requisi\u00e7\u00e3o deve ser o PUT<\/strong>.<\/p>\n
\"postagem_2_5\"<\/a><\/p>\n
Como se pode ver na imagem abaixo o body da response retorna o nosso objeto JSON<\/strong> com as altera\u00e7\u00f5es.<\/p>\n
\"postagem_2_6\"<\/a><\/p>\n
Por fim faremos uma requisi\u00e7\u00e3o do tipo DELETE (verbo REST usado excluir informa\u00e7\u00f5es)<\/strong> chamando a opera\u00e7\u00e3o localhost:8080\/person\/1<\/strong> passando como @PathVariable<\/strong> o ID da pessoa que desejamos remover da base. Esse tipo de requisi\u00e7\u00e3o retorna como resposta um body vazio e um StatusCode 200<\/strong> caso a opera\u00e7\u00e3o seja executada com sucesso os StatusCode 204 (no content)<\/strong>, 401 (Unauthorized)<\/strong>, 403 (forbiden)<\/strong>, 404 (not found)<\/strong> ou 500 (internal server error)<\/strong> podem ser retornados.<\/p>\n
\"postagem_2_7\"<\/a><\/p>\n
Dessa forma abordamos os 4 verbos principais do HTTP<\/strong> usados em aplica\u00e7\u00f5es REST<\/strong>. Lembrando que voc\u00ea pode baixar o c\u00f3digo aqui<\/a> e descompactar o arquivo zip e importar n\u00e3o sua IDE de preferencia ou clonar usando Git:<\/p>\n
\ngit clone https:\/\/github.com\/leandrocgsi\/simple-rest-example-verbs.git\n<\/pre>\n
Continue ligado no blog, por que no pr\u00f3ximo post iremos documentar a nossa API<\/strong> com o framewrok Swagger<\/strong>. E claro a abordagem nesses posts tamb\u00e9m ser\u00e1 totalmente m\u00e3o na massa. \u00c9 isso a\u00ed bons estudos.<\/p>\n
Treinamentos relacionados com este post<\/h2>\n
<\/p>\n

\n<\/a><\/p>\n

\n        
\n<\/a><\/p>\n

\n        
\n<\/a><\/p>\n

\n        
\n<\/a><\/p>\n

\n        
\n<\/a><\/p>\n

\n        
\n<\/a><\/p>\n

\n        
\n<\/a><\/p>\n<\/person><\/person><\/person><\/person>\n
<\/div><\/div><\/div>","protected":false},"excerpt":{"rendered":"
Neste post daremos continuidade a uma s\u00e9rie de postagens sobre Web-Services divididos entre conceitos te\u00f3ricos e praticos. Nos 3 primeiros posts focou-se em teoria com um sobre Web Services, outro sobre RESTful Web Services e mais um sobre os HTTP Status Codes mais comuns. Este post por sua vez complementa o que foi desenvolvido no […]<\/p>\n
\n
\n
<\/div>\n<\/div>\n<\/div>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[117,116,63,208,115,105],"tags":[205,204,209,203,210],"_links":{"self":[{"href":"https:\/\/www.semeru.com.br\/blog\/wp-json\/wp\/v2\/posts\/742"}],"collection":[{"href":"https:\/\/www.semeru.com.br\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.semeru.com.br\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.semeru.com.br\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.semeru.com.br\/blog\/wp-json\/wp\/v2\/comments?post=742"}],"version-history":[{"count":30,"href":"https:\/\/www.semeru.com.br\/blog\/wp-json\/wp\/v2\/posts\/742\/revisions"}],"predecessor-version":[{"id":1521,"href":"https:\/\/www.semeru.com.br\/blog\/wp-json\/wp\/v2\/posts\/742\/revisions\/1521"}],"wp:attachment":[{"href":"https:\/\/www.semeru.com.br\/blog\/wp-json\/wp\/v2\/media?parent=742"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.semeru.com.br\/blog\/wp-json\/wp\/v2\/categories?post=742"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.semeru.com.br\/blog\/wp-json\/wp\/v2\/tags?post=742"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}