Repository: syncope Updated Branches: refs/heads/master 8f1a55716 -> 75387d7ac
http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-reference.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-reference.adoc b/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-reference.adoc new file mode 100644 index 0000000..73bcf83 --- /dev/null +++ b/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-reference.adoc @@ -0,0 +1,62 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// +==== RESTful reference +If you want to read from the complete descriptive REST reference the URL you need is +[source] +-- +http://localhost:9080/syncope/ +-- +where you can see all the REST resources with their description, the parameters and the reference to the schema, +so you are able to see which attributes and which type are needed to the every service. +Following the same example as before, below two images to show the REST resources of the logger service and another one +for the reference to the schema: + +image::restReferenceLoggerRead.png[restReferenceLoggerRead] + +image::restReferenceLoggerUpdate.png[restReferenceLoggerUpdate] + +image::restSchemaReferenceLogger.png[restSchemaReferenceLogger] + +===== Swagger UI +From the 2.0 version, Syncope offers also the Swagger UI to work with its services. +The swagger interface is available going to the URL +[source] +-- +http://localhost:9080/syncope/swagger/#/ +-- + +Reading from the Swagger http://swagger.io/[website] + +.Swagger +**** +Swagger is a simple yet powerful representation of your RESTful API. With the largest ecosystem of API tooling on +the planet, thousands of developers are supporting Swagger in almost every modern programming language and deployment +environment. With a Swagger-enabled API, you get interactive documentation, client SDK generation and discoverability. + +We created Swagger to help fulfill the promise of APIs. Swagger helps companies like Apigee, Getty Images, Intuit, +LivingSocial, McKesson, Microsoft, Morningstar, and PayPal build the best possible services with RESTful APIs. + +Now in version 2.0, Swagger is more enabling than ever. And it's 100% open source software. + +**** + +To be consistent with the example, below the image shows the Swagger UI used to read the configuration +of _org.apache.syncope.core.rest_ + +image::swaggerLoggerRead.png[swaggerLoggerRead] http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-services.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-services.adoc b/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-services.adoc new file mode 100644 index 0000000..758bb74 --- /dev/null +++ b/src/main/asciidoc/workingwithapachesyncope/restfulservices/restful-services.adoc @@ -0,0 +1,30 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// +=== RESTful services +The RESTful services is the way how the Syncope core web application receives the input from the clients. +This layer, developed in http://cxf.apache.org/docs/jax-rs.html[Apache CXF 2.0], is usually reachable under the +root context of the deployment. +[source] +-- +http://localhost:9080/syncope/rest +-- + +include::restful-reference.adoc[] + +include::client-library.adoc[] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/syncope/blob/75387d7a/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc b/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc new file mode 100644 index 0000000..7b62493 --- /dev/null +++ b/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc @@ -0,0 +1,39 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// +== Working with Apache Syncope + +=== Using the Admin Console + +include::cli/cli.adoc[] + +include::restfulservices/restful-services.adoc[] + +=== Customization + +==== Core + +==== Console + +==== New extensions + +=== Deploying in production + +=== Options + +=== High-Availability \ No newline at end of file
