Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Register
  • Sign in
  • A admin-wiki
  • Project information
    • Project information
    • Activity
    • Members
  • Wiki
    • Wiki
  • Activity
Collapse sidebar
  • public
  • admin-wiki
  • Wiki
  • Apiary and Swagger documentation

Apiary and Swagger documentation · Changes

Page history
Update Apiary and Swagger documentation authored Mar 08, 2019 by Jan Kelin's avatar Jan Kelin
Hide whitespace changes
Inline Side-by-side
Apiary-and-Swagger-documentation.md
View page @ ba653f7c
## Swagger/OpenApi documentation
1. Go to admin > bank > open api documents ![image](uploads/ff35b051e70cc16cc853542cd4116a2f/image.png)
2. Create document and publish it ![image](uploads/5620a704f4a9a40c6fa069224f7257d3/image.png)
3. Copy it's special swagger url ![image](uploads/8acfa95d69a0eb6eca04c94c862da2f4/image.png)
1. Go to admin > bank > open api documents ![image](uploads/840c592857300d4d2e7ce4b9f16c98ee/image.png)
2. Create document and publish it ![image](uploads/47880bd2fc4c7e4ebe40ee7c545527ef/image.png)
3. Copy it's special swagger url ![image](uploads/5c0d21845f0febbfa4a853b739e1d610/image.png)
4. Use this swagger url instead of apiary url when setting up import for API configurator. This is documented here https://apiconfigurator1.docs.apiary.io/#introduction/dictionary-object field `documentation`. Bank does this so it is very hard to test
5. Trigger API import ![image](uploads/3969dd93f5ee15602051ab3a95f20bc6/image.png)
6. Observe imported API on portal webfront ![image](uploads/4204febaabf1859eec08fb97972ab2e0/image.png)
5. Trigger API import ![image](uploads/10e10beb70f6e39da0b56745703c6e3b/image.png)
6. Observe imported API on portal webfront ![image](uploads/8031f59f74c966863fcec92250ef6ce2/image.png)
Technically it is important to say that swagger urls are constructed as `swagger://slug`. If portal FE sees this url, it will extract the slug and use it to query hub-catalog where swagger documents are stored.
\ No newline at end of file
Clone repository
  • Apiary and Swagger documentation
  • Home