mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-31 17:39:05 +00:00
Move governance-services code to amps/ags
This commit is contained in:
alandavis
@@ -0,0 +1,43 @@
|
||||
# Alfresco Records Management Community REST API Explorer
|
||||
Records Management Community REST API Definition Explorer
|
||||
|
||||
|
||||
#### Building and deploying the war
|
||||
- `mvn clean install`
|
||||
|
||||
You now have a `target/alfresco-rm-community-rest-api-explorer-2.6-SNAPSHOT.war`, drop this into your Application server that is running alfresco.war
|
||||
|
||||
|
||||
#### For development only
|
||||
You can run the project as a packaged web application using an embedded Tomcat server.
|
||||
This is useful for changing documentation and endpoint descriptions but it means that the "Try it Out!" button will not work.
|
||||
|
||||
- ` mvn clean install -Pstart-api-explorer`
|
||||
|
||||
Now the application is running at [http://localhost:8085/api-explorer](http://localhost:8085/api-explorer/)
|
||||
|
||||
#### Config option
|
||||
You can run tomcat on another port using the following command
|
||||
|
||||
- ` mvn clean install -Pstart-api-explorer -Dmaven.tomcat.port=8086`
|
||||
|
||||
Then the application will run at [http://localhost:8086/api-explorer](http://localhost:8086/api-explorer/)
|
||||
|
||||
### License
|
||||
Copyright (C) 2016 Alfresco Software Limited
|
||||
|
||||
This file is part of an unsupported extension to Alfresco.
|
||||
|
||||
Alfresco Software Limited 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.
|
||||
75
amps/ags/rm-community/rm-community-rest-api-explorer/pom.xml
Normal file
75
amps/ags/rm-community/rm-community-rest-api-explorer/pom.xml
Normal file
@@ -0,0 +1,75 @@
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<artifactId>alfresco-governance-services-community-rest-api-explorer</artifactId>
|
||||
<name>Alfresco Governance Services Community REST API Explorer</name>
|
||||
<packaging>war</packaging>
|
||||
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-governance-services-community</artifactId>
|
||||
<version>3.5.1-SNAPSHOT</version>
|
||||
</parent>
|
||||
|
||||
<properties>
|
||||
<maven.javadoc.skip>false</maven.javadoc.skip>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
|
||||
</properties>
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-war-plugin</artifactId>
|
||||
<configuration>
|
||||
<failOnMissingWebXml>false</failOnMissingWebXml>
|
||||
<overlays>
|
||||
<overlay>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>api-explorer</artifactId>
|
||||
<excludes>
|
||||
<exclude>definitions/*</exclude>
|
||||
</excludes>
|
||||
</overlay>
|
||||
</overlays>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
<profiles>
|
||||
<profile>
|
||||
<id>start-api-explorer</id>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.tomcat.maven</groupId>
|
||||
<artifactId>tomcat7-maven-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>run-war</id>
|
||||
<goals>
|
||||
<goal>run-war</goal>
|
||||
</goals>
|
||||
<phase>verify</phase>
|
||||
</execution>
|
||||
</executions>
|
||||
<configuration>
|
||||
<path>/api-explorer</path>
|
||||
<port>8085</port>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</profile>
|
||||
</profiles>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>api-explorer</artifactId>
|
||||
<version>${api.explorer.version}</version>
|
||||
<type>war</type>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</project>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,81 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>Alfresco Governance Services REST API Explorer</title>
|
||||
<link rel="stylesheet" type="text/css" href="./swagger-ui.css">
|
||||
<link href='./css/alfresco.css' media='screen' rel='stylesheet' type='text/css'/>
|
||||
|
||||
<link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32"/>
|
||||
<link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16"/>
|
||||
<style>
|
||||
html
|
||||
{
|
||||
box-sizing: border-box;
|
||||
overflow: -moz-scrollbars-vertical;
|
||||
overflow-y: scroll;
|
||||
}
|
||||
*, *:before, *:after
|
||||
{
|
||||
box-sizing: inherit;
|
||||
}
|
||||
body
|
||||
{
|
||||
margin:0;
|
||||
background: #fafafa;
|
||||
padding:0;
|
||||
}
|
||||
|
||||
.swagger-ui .topbar {
|
||||
background-color: #e6e6ec;
|
||||
}
|
||||
.swagger-ui .topbar .download-url-wrapper .select-label {
|
||||
color: #333;
|
||||
}
|
||||
.topbar-wrapper img[alt="Swagger UI"] {
|
||||
visibility: collapse;
|
||||
}
|
||||
.topbar-wrapper .link:before {
|
||||
content:url('images/logo.svg');
|
||||
}
|
||||
|
||||
/* https://stackoverflow.com/a/65782841/1654265 */
|
||||
.errors-wrapper {
|
||||
display: none !important;
|
||||
}
|
||||
|
||||
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div id="swagger-ui"></div>
|
||||
|
||||
<script src="./swagger-ui-bundle.js" charset="UTF-8"></script>
|
||||
<script src="./swagger-ui-standalone-preset.js" charset="UTF-8"></script>
|
||||
<script>
|
||||
window.onload = function() {
|
||||
|
||||
const ui = SwaggerUIBundle({
|
||||
urls: [
|
||||
{url: "definitions/gs-core-api.yaml", name: "GS Core API"}
|
||||
],
|
||||
dom_id: '#swagger-ui',
|
||||
deepLinking: true,
|
||||
displayRequestDuration: true,
|
||||
presets: [
|
||||
SwaggerUIBundle.presets.apis,
|
||||
SwaggerUIStandalonePreset
|
||||
],
|
||||
plugins: [
|
||||
SwaggerUIBundle.plugins.DownloadUrl
|
||||
],
|
||||
layout: "StandaloneLayout"
|
||||
})
|
||||
|
||||
window.ui = ui
|
||||
}
|
||||
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user