= SwaggerService
:Notice: 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.

Generates Swagger schema definition files to describe the public and/or private RESTful APIs exposed by the RestfulObjects viewer.

These spec files can then be used with the link:http://swagger.io/swagger-ui/[Swagger UI] page to explore the REST API, or used to generate client-side stubs using the link:http://swagger.io/swagger-codegen/[Swagger codegen] tool, eg for use in a custom REST client app.

== API

[source,java]
.SwaggerService.java
----
interface SwaggerService {
  String generateSwaggerSpec(Visibility visibility, Format format)     // <.>
}
----

<.> xref:#generateSwaggerSpec_Visibility_Format[generateSwaggerSpec(Visibility, Format)]
+
--
Generate a Swagger spec with the specified visibility and format.
--

== Members

[#generateSwaggerSpec_Visibility_Format]
=== generateSwaggerSpec(Visibility, Format)

Generate a Swagger spec with the specified visibility and format.

include::hooks/SwaggerService_010-implementation.adoc[]

include::hooks/SwaggerService_020-examples-and-usage.adoc[]
