|
|
## Swagger/OpenApi documentation
|
|
## Swagger/OpenApi documentation
|
|
|
1. Go to admin > bank > open api documents 
|
|
1. Go to admin > bank > open api documents 
|
|
|
2. Create document and publish it 
|
|
2. Create document and publish it 
|
|
|
3. Copy it's special swagger url 
|
|
3. Copy it's special swagger url 
|
|
|
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
|
|
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 
|
|
5. Trigger API import 
|
|
|
6. Observe imported API on portal webfront 
|
|
6. Observe imported API on portal webfront 
|
|
|
|
|
|
|
|
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. |
|
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 |
