Skip to content

Commit c72b199

Browse files
committed
updating composer instructions
1 parent 5856b5e commit c72b199

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

jsondiscoverer.web/WebContent/app/partials/composition.html

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,12 @@ <h2>How does it work?
1010
</div>
1111
</div>
1212
<div class="col-md-6">
13-
<p>The composition discoverer <strong>infers a set of matching elements</strong> from a set of JSON documents (coming from the same or several sources).
14-
It generates that allows you to easily visualize how your APIs can be composed.</p>
15-
<p>To use the composition discoverer follow these steps:</p>
13+
<p>The API composer <strong>looks for matching elements in different API schemas and generates a composition graph</strong>. The result is used to assist developers to compose APIs. The tool currently incoporates a sequence diagram generator to visualize API compositions.</p>
14+
<p>To use the API composer follow these steps:</p>
1615
<ul>
17-
<li><strong>Step 1. Provision.</strong> You have to provide two or more JSON sources. For each source you have to give a name and provide the input (optional) and one or more JSON definitions.</li>
18-
<li><strong>Step 2. Composition discovery.</strong> For each JSON source we will discovery the schema information and then we all (sub)schemas will be composed in a graph where
19-
graph nodes represents schema concepts and attributes. We will discover as well possible links among these concepts.</li>
20-
<li><strong>Step 3. Composition Graph.</strong> You can apply the layout to better read the graph.</li>
16+
<li><strong>Step 1. Provision.</strong> You have to provide two or more JSON sources. For each source you have to give a name and provide the input (optional) and one or more JSON documents.</li>
17+
<li><strong>Step 2. Composition discovery.</strong> For each JSON source we will discover the schema information.</li>
18+
<li><strong>Step 3. Composition Graph.</strong> The discovered schemas will be composed in a graph where graph nodes represents schema concepts and attributes. We will discover as well possible links among these concepts. You can apply the layout to better read the graph.</li>
2119
<li><strong>Step 4. Calculate a Path.</strong> Paths in the graph can represent API compositions. Given a source and a target nodes, you can calculate a path, which we will represent
2220
as a sequence diagram.</li>
2321

0 commit comments

Comments
 (0)