Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benevanio/api-core
Criando o contrato da API em RAML.
https://github.com/benevanio/api-core
anypoint-design-center api api-docs api-documentation api-gateway challenge exchange mule mule-api mulesoft mulesoft-connector raml rest restful-api
Last synced: about 1 month ago
JSON representation
Criando o contrato da API em RAML.
- Host: GitHub
- URL: https://github.com/benevanio/api-core
- Owner: Benevanio
- License: apache-2.0
- Created: 2023-07-06T11:53:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-06T14:38:03.000Z (over 1 year ago)
- Last Synced: 2024-09-26T01:41:26.183Z (3 months ago)
- Topics: anypoint-design-center, api, api-docs, api-documentation, api-gateway, challenge, exchange, mule, mule-api, mulesoft, mulesoft-connector, raml, rest, restful-api
- Language: RAML
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# API-CORE
**Este repositório tem fins exclusivamente educacionais.**
O objetivo deste repositório é criar uma API no Design Center, importá-la no Anypoint Studio e testar os endpoints da API no Postman.
Para a criação da API, utilizamos o RAML (RESTful API Modeling Language), uma linguagem baseada em YAML que permite descrever os fluxos da nossa API.
Root File: No Root File, temos a descrição dos métodos presentes na nossa API:
````
/search:
get:
queryParameters:
keyword:
type: string
minLength: 3
maxLength: 10
responses:
200:
body:
application/json:
example: !include /examples/searchExample.raml
````
Nesta parte do código, temos o endpoint search, que recebe o método HTTP GET, seguido dos parâmetros de pesquisa (queryParameters), que são usados para enviar dados para o servidor. No exemplo selecionado, o parâmetro de consulta keyword é definido como uma string com um comprimento mínimo de 3 e um comprimento máximo de 10 caracteres. Se este resultado obtiver um retorno positivo, teremos um status code 200 com uma mensagem de sucesso, em RAML a especificação desta mensagem é mais ou menos da seguinte maneira:
```
#%RAML 1.0 NamedExample
{"message": "result returned sucessfull"}
```
Em seguida, vamos para o nosso banco de dados (database), que define um tipo de dados com duas propriedades: username e password.
A propriedade username é definida como obrigatória e deve ter um comprimento mínimo de 5 e um comprimento máximo de 10 caracteres.
A propriedade password também é definida como obrigatória e deve ter um comprimento mínimo de 6 e um comprimento máximo de 10 caracteres.
## Demonstração
API NO DESIGN CENTER:
UTLIZAÇAO DO CONTRATO NO ANYPOINT STUDIO:
REALIZAÇÂO DO TESTE NO POSTMAN:
