Skip to content

Commit b9dfac1

Browse files
authored
Merge pull request #8454 from mendix/qt-consumedrestupdates
Revise REST Services index
2 parents 9232c15 + 62b96c4 commit b9dfac1

File tree

6 files changed

+47
-40
lines changed

6 files changed

+47
-40
lines changed

content/en/docs/appstore/creating-content/connector-guide-build/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Connectors can be used in your app to simplify connecting to existing third-part
3535

3636
### Connecting to Other Systems
3737

38-
Connectors are implemented as Mendix modules with a focus on connecting to other systems. Connectors can make use of any of the platform-supported protocols like [SOAP](/refguide/consumed-web-services/#soap), [REST](/refguide/consumed-rest-services/#rest), [OData](/refguide/consumed-odata-services/#external-entities), or [Catalog](/catalog/).
38+
Connectors are implemented as Mendix modules with a focus on connecting to other systems. Connectors can make use of any of the platform-supported protocols like [SOAP](/refguide/consumed-web-services/#soap), [REST](/refguide/integration/rest-services/), [OData](/refguide/consumed-odata-services/#external-entities), or [Catalog](/catalog/).
3939

4040
They can also be used to package a Java library provided by the other system to make the connection. These Java library functions can be exposed via Java actions as custom microflow activities (see [How to Build Microflow Actions with Java](/howto/extensibility/howto-connector-kit/)). This makes it simpler for Mendix developers without in-depth knowledge about third-party integrations to use these connectors in their business logic.
4141

content/en/docs/refguide/modeling/integration/rest-services/_index.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,38 @@ Representational state transfer (REST) is an approach to consuming or exposing r
1111

1212
* HTTP URLs to locate resources
1313
* HTTP headers to authenticate and specify content types (such as XML or JSON)
14-
* HTTP methods to identify operations on resources, such as GET (retrieve data) or POST (send data)
14+
* HTTP methods to identify operations on resources, such as `GET` (retrieve data) or `POST` (send data)
15+
16+
Lack of contracts and schemas give you an easy start to using REST. However, many REST endpoints return complex data.
17+
18+
The [JSON Structure](/refguide/json-structures/) document helps to give structure to JSON data. From an example JSON snippet, a lightweight schema is extracted that is used in [Mapping Documents](/refguide/mapping-documents/).
19+
The [Import Mapping](/refguide/import-mappings/) document converts JSON (or XML) to Mendix objects, and the [Export Mapping](/refguide/export-mappings/) document serializes Mendix objects to JSON (or XML).
20+
21+
## Content Types {#content-types}
22+
23+
Content types are included in [custom HTTP headers](/refguide/call-rest-action/#custom-http-headers) to specify the output of the call, including media type or data format. For more information on content types, see [Content Negotiation in REST](https://restfulapi.net/content-negotiation/).
24+
25+
## JSON
26+
27+
JavaScript object notation (JSON) is a lightweight representation of data.
28+
29+
```js
30+
{
31+
"name": "John Smith",
32+
"age": 23,
33+
"address":
34+
{
35+
"street": "Dopeylane 14",
36+
"city": "Worchestire"
37+
}
38+
}
39+
```
40+
41+
Above, the object `person` is described with the corresponding values for the attributes `name`, `age`, and the referred object `address`.
42+
43+
REST calls that output JSON need to declare the [content type](#content-types) as `application/JSON`.
44+
45+
## Documents in This Category
1546

1647
To publish REST services, see:
1748

@@ -21,7 +52,7 @@ To publish REST services, see:
2152

2253
To consume REST services, see:
2354

24-
* [Consumed REST Services](/refguide/consumed-rest-services/), an overview in the Studio Pro guide
55+
* [Consumed REST Services (Beta)](/refguide/consumed-rest-services-beta/), an overview on how to Consume a REST Service
2556
* [Call REST Service](/refguide/call-rest-action/), a description of the microflow action
26-
* [Consume a REST Service](/howto/integration/consume-a-rest-service/) for step-by-step instructions
57+
* [Use Call REST Service Action in a Microflow](/refguide/integration/use-call-rest-action-in-microflow/), instructions on how to use the Call REST Service action in a microflow
2758
* [HttpRequest and HttpResponse System Entities](/refguide/http-request-and-response-entities/), an overview of these system entities in your domain model

content/en/docs/refguide/modeling/integration/rest-services/consumed-rest-services/_index.md

Lines changed: 7 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,13 @@ weight: 15
66
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
77
---
88

9-
## REST {#rest}
9+
## Consumed REST Services
1010

11-
Representational state transfer (REST) is an approach to consuming or exposing resources. It has gained popularity because of its simplicity, because no extensive schemas or contracts are needed to transfer data between endpoints. It uses the following:
11+
The Consumed REST Service document allows you to interact with any REST API. You can build, test, and create data structures to store your REST requests.
1212

13-
* HTTP URLs to locate resources
14-
* HTTP headers to authenticate and specify [content types](#content-types) (such as XML or JSON)
15-
* HTTP methods to identify operations on resources, such as `GET` (retrieve data) or `POST` (send data)
13+
## Documents in This Category
1614

17-
Lack of contracts and schemas give you an easy start to using REST. However, many REST endpoints return complex data.
18-
19-
The [JSON Structure](/refguide/json-structures/) document helps to give structure to JSON data. From an example JSON snippet, a lightweight schema is extracted that is used in [Mapping Documents](/refguide/mapping-documents/). The [Import Mapping](/refguide/import-mappings/) document converts JSON (or XML) to Mendix objects, and the [Export Mapping](/refguide/export-mappings/) document serializes Mendix objects to JSON (or XML).
20-
21-
### Content Types {#content-types}
22-
23-
Content types are included in [custom HTTP headers](/refguide/call-rest-action/#custom-http-headers) to specify the output of the call, including media type or data format. For more information on content types, see [Content Negotiation in REST](https://restfulapi.net/content-negotiation/).
24-
25-
## JSON
26-
27-
JavaScript object notation (JSON) is a lightweight representation of data.
28-
29-
```js
30-
{
31-
"name": "John Smith",
32-
"age": 23,
33-
"address":
34-
{
35-
"street": "Dopeylane 14",
36-
"city": "Worchestire"
37-
}
38-
}
39-
```
40-
41-
Above, the object `person` is described with the corresponding values for the attributes `name`, `age`, and the referred object `address`.
42-
43-
REST calls that output JSON need to declare the [content type](#content-types) as `application/JSON`.
15+
* [Consumed REST Services (Beta)](/refguide/consumed-rest-services-beta/), an overview on how to Consume a REST Service
16+
* [Call REST Service](/refguide/call-rest-action/), a description of the microflow action
17+
* [Use Call REST Service Action in a Microflow](/refguide/integration/use-call-rest-action-in-microflow/), instructions on how to use the Call REST Service action in a microflow
18+
* [HttpRequest and HttpResponse System Entities](/refguide/http-request-and-response-entities/), an overview of these system entities in your domain model

content/en/docs/refguide/modeling/integration/rest-services/consumed-rest-services/server-side-paging.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,7 @@ Deploy your app again and navigate to the page with your data grid. Enter a valu
218218
219219
## Read More
220220
221-
* [Consume a REST Service](/howto/integration/consume-a-rest-service/)
221+
* [REST Services](/refguide/integration/rest-services/)
222222
* [JSON Structures Guide](/refguide/json-structures/)
223-
* [Consumed REST Services Guide](/refguide/consumed-rest-services/)
223+
* [Consumed REST Services](/refguide/consumed-rest-services-beta/)
224+
* [Use Call REST Service Action in a Microflow](/refguide/integration/use-call-rest-action-in-microflow/)
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Advanced Consumed REST Services"
3-
url: /refguide/integration/consume-a-rest-service/
2+
title: "Use Call REST Service Action in a Microflow"
3+
url: /refguide/integration/use-call-rest-action-in-microflow/
44
weight: 9
55
description: "Describes how to integrate an existing system or a legacy system into a Mendix app by calling a REST service in a microflow."
66
description: "Describes how to get information from a REST service."

0 commit comments

Comments
 (0)