2432: API docs (openapi) update

Author: turegjorup

.env

@@ -24,6 +24,14 @@ APP_SECRET=01324d73757787ffeba5f2f76cec1a28
 
 ###> app ###
 APP_PATH_PREFIX=/api/v2
+APP_PROJECT_URI=https://${COMPOSE_DOMAIN}
+
+OPENAPI_TITLE='Event Database'
+OPENAPI_DESCRIPTION='API for the Event Database'
+OPENAPI_CONTACT_NAME='Contact Name'
+OPENAPI_CONTACT_URL='https://github.com/itk-dev/event-database-api/'
+OPENAPI_CONTACT_EMAIL='contact@example.org'
+OPENAPI_TERMS_OF_SERVICE='https://example.org'
 
 # Must be valid json, usernames and apikeys must be unique
 # APP_API_KEYS='[{"username": "user_1", "apikey": "api_key_1"}, {"username": "user_2", "apikey": "api_key_2"}]'
@@ -40,6 +48,7 @@ INDEX_URL=http://elasticsearch:9200
 INDEX_EVENTS_ALIAS=events
 INDEX_ORGANIZATION_ALIAS=organization
 ###< INDEX ###
+
 ###> nelmio/cors-bundle ###
 CORS_ALLOW_ORIGIN='*'
 ###< nelmio/cors-bundle ###

config/packages/api_platform.yaml

@@ -1,8 +1,16 @@
 api_platform:
-    title: Event database API
+    title: '%env(OPENAPI_TITLE)%'
+    description: '%env(OPENAPI_DESCRIPTION)%'
     version: 2.0.0
     show_webby: false
 
+    openapi:
+        contact:
+            name: '%env(OPENAPI_CONTACT_NAME)%'
+            url: '%env(OPENAPI_CONTACT_URL)%'
+            email: '%env(OPENAPI_CONTACT_EMAIL)%'
+        termsOfService: '%env(OPENAPI_TERMS_OF_SERVICE)%'
+
     formats:
         jsonld: ['application/ld+json']
 

config/packages/twig.yaml

@@ -1,6 +1,9 @@
 twig:
     default_path: '%kernel.project_dir%/templates'
 
+    globals:
+        app_project_uri: '%env(APP_PROJECT_URI)%'
+
 when@test:
     twig:
         strict_variables: true

public/styles/aak-logo-1.svg

@@ -0,0 +1,85 @@
+/** HEADER **/
+
+header:before {
+    background: white;
+    box-shadow: none;
+    z-index: -100;
+}
+
+header {
+    margin-bottom: -60px;
+
+    #logo {
+        right: 60px;
+        top: 40px;
+        position: absolute;
+
+        img {
+            background: none;
+        }
+    }
+}
+
+.swagger-ui .info a {
+    font-family: "Arial", "Helvetica", sans-serif;
+    color: rgb(0, 156, 220);
+}
+
+#swagger-ui.api-platform .info .title {
+    font-family: "Arial", "Helvetica", sans-serif;
+    color: rgb(66, 66, 66);
+}
+
+.swagger-ui .info p {
+    font-family: "Arial", "Helvetica", sans-serif;
+    color: rgb(66, 66, 66);
+}
+
+.swagger-ui .info > div.info__tos {
+    position: absolute;
+}
+
+.swagger-ui .info > div.info__contact {
+    position: absolute;
+    left: 200px;
+}
+
+#swagger-ui.api-platform .information-container.wrapper {
+    height: 140px;
+}
+
+.swagger-ui .info > div.info__contact > a.link {
+    position: absolute;
+    top: 0;
+    left: 200px;
+    width: 200px;
+}
+
+#swagger-ui.api-platform .opblock.opblock-get .opblock-summary-method {
+    background-color: rgb(31, 161, 56);
+}
+
+#swagger-ui.api-platform .opblock-section-header, #swagger-ui.api-platform .opblock.opblock-get .opblock-section-header {
+    background-color: rgb(31, 161, 56, .1);
+}
+
+.swagger-ui .btn.authorize {
+    border-color: rgb(31, 161, 56);
+    color: rgb(31, 161, 56);
+}
+
+#swagger-ui.api-platform .btn.authorize {
+    background-color: rgb(31, 161, 56, .1);
+}
+
+.swagger-ui .btn.authorize svg {
+    fill: rgb(31, 161, 56);
+}
+
+.swagger-ui .info .title small {
+    background-color: rgb(0, 156, 220);
+}
+
+.swagger-ui .info .title small.version-stamp {
+    background-color: rgb(31, 161, 56);
+}

public/styles/swagger-ui.css

@@ -0,0 +1,14 @@
+{% extends "@!ApiPlatform/SwaggerUi/index.html.twig" %}
+
+{% block stylesheet %}
+    {{ parent() }}
+    <link rel="stylesheet" href="{{ asset('/api/v2/styles/swagger-ui.css', assetPackage) }}">
+{% endblock %}
+
+{% block header %}
+    <header>
+        <a id="logo" href="{{ app_project_uri }}">
+            <img src="{{ asset('/api/v2/styles/aak-logo-1.svg', assetPackage) }}" alt="API Platform">
+        </a>
+    </header>
+{% endblock %}