Spring/spring-data-rest
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation.

Browse Source
This commit is contained in:
Jon Brisbin
2013-03-02 11:55:21 -06:00
parent de80e462f4
commit f87ed05d1d
4 changed files with 40 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/reference/docbook/index.xml
View File

@@ -44,5 +44,6 @@
<xi:include href="intro.xml"/>
<xi:include href="representations.xml"/>
<xi:include href="install.xml"/>
</book>

26
src/reference/docbook/install.xml Normal file
View File

@@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xml:id="install-chapter"
xmlns="http://docbook.org/ns/docbook"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://docbook.org/ns/docbook http://www.oasis-open.org/docbook/xml/5.0/xsd/docbook.xsd">
<title>Installing Spring Data REST</title>
<section>
<title>Adding Spring Data REST to an existing Spring MVC application</title>
<para>Spring Data REST is itself a Spring MVC application and is designed in such a way that it should integrate
with your existing Spring MVC applications with very little effort. An existing (or future) layer of services can
run alongside Spring Data REST with only minor considerations.
</para>
<para>To install Spring Data REST alongside your application, simply add the required dependencies, include the
stock
<code>@Configuration</code>
class (or subclass it and perform any required manual configuration), and map some URLs to be managed by Spring
Data REST.
</para>
</section>
</chapter>

42
src/reference/docbook/intro.xml
View File

@@ -728,77 +728,57 @@ http://api.myservice.com/v1:>]]></programlisting>
<tr>
<td>
<cmdsynopsis>
<command></command>
<command>put</command>
</cmdsynopsis>
</td>
<td>
<para></para>
<para>HTTP PUT to the given path, passing JSON given in the --data parameter.</para>
</td>
</tr>
<tr>
<td>
<cmdsynopsis>
<command></command>
<command>delete</command>
</cmdsynopsis>
</td>
<td>
<para></para>
<para>HTTP DELETE to the given path.</para>
</td>
</tr>
<tr>
<td>
<cmdsynopsis>
<command></command>
<command>auth basic</command>
</cmdsynopsis>
</td>
<td>
<para></para>
<para>Set an HTTP Basic authentication token for use in this session.</para>
</td>
</tr>
<tr>
<td>
<cmdsynopsis>
<command></command>
<command>auth clear</command>
</cmdsynopsis>
</td>
<td>
<para></para>
<para>Clear the Authorization header currently in use.</para>
</td>
</tr>
<tr>
<td>
<cmdsynopsis>
<command></command>
<command>ssl validate</command>
</cmdsynopsis>
</td>
<td>
<para></para>
</td>
</tr>
<tr>
<td>
<cmdsynopsis>
<command></command>
</cmdsynopsis>
</td>
<td>
<para></para>
<para>Disable certificate checking to work with self-signed certificates.</para>
</td>
</tr>
</table>
<para>
get - HTTP GET from the given path.
post - HTTP POST to the given path, passing JSON given in the --data parameter.
put - HTTP PUT to the given path, passing JSON given in the --data parameter.
delete - HTTP DELETE to the given path.
auth basic - Set an HTTP Basic authentication token for use in this session.
auth clear - Clear the Authorization header currently in use.
ssl validate - Disable certificate checking to work with self-signed certificates.
</para>
</section>
</section>
</chapter>

3
src/reference/docbook/representations.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xml:id="intro-chapter"
<chapter xml:id="representations-chapter"
xmlns="http://docbook.org/ns/docbook"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://docbook.org/ns/docbook http://www.oasis-open.org/docbook/xml/5.0/xsd/docbook.xsd">
@@ -26,6 +26,7 @@
content-type.
</para>
</footnote>
</para>
</section>