diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 70e555a..681c129 100755 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -44,6 +44,7 @@ module.exports = { { text: 'Getting Started', link: '/guide/' }, { text: 'Tutorials', link: '/tutorials/'}, { text: 'ObjectAPI Specification', link: '/objectapi/' }, + { text: 'API Solutions', link: '/solutions/' }, { text: 'ObjectAPI Mappings', link: '/mappings/' } , { text: 'ObjectLink Specification', link: '/objectlink/' } ] @@ -81,6 +82,13 @@ module.exports = { children: [''] } ], + '/studio/': [ + { + title: 'Desktop Studio', + collapsable: false, + children: ['', 'projects', 'new', 'dashboard', 'modules', 'solutions', 'simulations', 'monitoring', 'templates', 'logs', 'settings'] + }, + ], '/tutorials/': [ { title: 'Tutorials', @@ -95,6 +103,13 @@ module.exports = { children: ['', 'cpp14-sdk', 'qtcpp-sdk', 'python-sdk', 'go-sdk', 'typescript-sdk'] } ], + '/solutions/': [ + { + title: 'Solutions', + collapsable: false, + children: [''] + } + ], '/simulation/': [ { title: 'Simulation', diff --git a/docs/solutions/index.md b/docs/solutions/index.md new file mode 100644 index 0000000..f215dfc --- /dev/null +++ b/docs/solutions/index.md @@ -0,0 +1,7 @@ +# API Solutions + +The API solution document captures the configuration of API modules and the technology templates used to generate the source code. You can see it as a recipe for creating a larger single or multi layered SDK. + +The solution consist of a set of layers. Each layer is a combination of API modules with a technology template and an output folder. + +When a solution runs it generates for each layer a SDK. This is very helpful in case you want to create a solution based on the same API for multiple targets and languages. diff --git a/docs/studio/dashboard.md b/docs/studio/dashboard.md new file mode 100644 index 0000000..721823b --- /dev/null +++ b/docs/studio/dashboard.md @@ -0,0 +1,7 @@ +# Dashboard + +The dashboard shows you all the API documents in the project. These are typically API modules, solutions and simulation documents. + +![Studio Dashboard](./studio-dashboard.png) + +When you click on a document, you will open the document in a more detailed view. From there you can edit the document or delete it. Also i the specific view you can run the associated actions. diff --git a/docs/studio/index.md b/docs/studio/index.md new file mode 100644 index 0000000..d8c72b3 --- /dev/null +++ b/docs/studio/index.md @@ -0,0 +1,10 @@ +# Desktop Studio + +The ApiGear Desktop Studio allows you to manage your API modules and solutions in a simple and intuitive way. +Furthermore, it provides access to the simulation docs and an overview of API events in the monitoring view. + +![Desktop Studio](./studio-desktop.png) + +The desktop application is available on windows/mac and linux. It can be installed from the [Studio download site](https://github.com/apigear-io/apigear-studio/releases). + +At the bottom of the application you can find a link to the current version and to the API discussions forum. diff --git a/docs/studio/logs.md b/docs/studio/logs.md new file mode 100644 index 0000000..f0fca79 --- /dev/null +++ b/docs/studio/logs.md @@ -0,0 +1,5 @@ +# Log Events + +The logs view shows you all the log messages in the project. Here you can get an overview of the behavior of the project and the application. + +The logs show you log messages during code generation, monitoring and simulation. Also warnings and errors will be displayed here. diff --git a/docs/studio/modules.md b/docs/studio/modules.md new file mode 100644 index 0000000..d1d849e --- /dev/null +++ b/docs/studio/modules.md @@ -0,0 +1,11 @@ +# API Modules + +The API Modules View shows you all the API modules in the project. You can edit and delete the documents. + +![Studio Modules](./studio-modules.png) + +API modules are typically used inside API solutions with technology templates to generate API SDKs. + +An API module describes a set of interfaces and operations which can be translated to different output using the technology templates. + +API Modules are described in detail in the [ObjectAPI guide](/objectapi). diff --git a/docs/studio/monitoring.md b/docs/studio/monitoring.md new file mode 100644 index 0000000..011f69c --- /dev/null +++ b/docs/studio/monitoring.md @@ -0,0 +1,11 @@ +# API Monitor + +The API Monitoring view shows you all the API events in the project. You can also halt the monitoring to better view th events. When you continue the monitoring, the events will continue with the latest events. + +![Studio Monitoring](./studio-monitor.png) + +The events are ordered by the time with the newest on top. There are different events based if the event is an API call, a state change or a server side signal. + +Each events shows the source of the event and the attached data. + +Monitoring events are described in detail in the [monitoring guide](/monitoring). diff --git a/docs/studio/new.md b/docs/studio/new.md new file mode 100644 index 0000000..79f89ea --- /dev/null +++ b/docs/studio/new.md @@ -0,0 +1,5 @@ +# New Documents + +To create a new document press the `New +` button and select the type of document you want to create. A dialog will open to enter the document name. The document will be created in the current project. + +![New Document](./studio-new-docs.png) diff --git a/docs/studio/projects.md b/docs/studio/projects.md new file mode 100644 index 0000000..c2a655f --- /dev/null +++ b/docs/studio/projects.md @@ -0,0 +1,19 @@ +# API Projects + +The dashboard shows the recently used API projects and allows you to create new API projects or import exiting projects. + +![Studio Projects](./studio-projects.png) + +:::tip +The API project is basically a folder with an `apigear` folder containing the API documents. +::: + +To create a new project, click the `Create Project` button and enter the location of the project folder. + +:::tip +Ensure yu always used the folder where the `apigear` folder is located in. +::: + +- To import an existing project, click the `Import Project` button and provide the import location of the exiting project. +- To open an existing project, click the `Open Project` button and select the project folder. +- To open a recently used project, click one of the recent projects in the list. diff --git a/docs/studio/settings.md b/docs/studio/settings.md new file mode 100644 index 0000000..a283718 --- /dev/null +++ b/docs/studio/settings.md @@ -0,0 +1,5 @@ +# Settings + +Settings allows you to set the different network settings for the monitor and simulation endpoints. + +![Studio Settings](./studio-settings.png) diff --git a/docs/studio/simulations.md b/docs/studio/simulations.md new file mode 100644 index 0000000..aa9455b --- /dev/null +++ b/docs/studio/simulations.md @@ -0,0 +1,9 @@ +# API Simulations + +The API Simulation View shows you all the API simulation documents in the project. You can edit and delete the documents. You can also run the simulation, which will run a simulation server loaded with the selected simulation. + +![Studio Simulations](./studio-simulations.png) + +Now you can target your client API towards the simulation server and use the API to test the simulation, without a service backend required. + +The simulation document format is described in the [simulation guide](/simulation). diff --git a/docs/studio/solutions.md b/docs/studio/solutions.md new file mode 100644 index 0000000..ae972c4 --- /dev/null +++ b/docs/studio/solutions.md @@ -0,0 +1,7 @@ +# API Solutions + +The API Solutions View shows you all the API solutions in the project. You can edit and delete the documents. You can also run the solution, which will run all the API modules in the solution and generate the source code using the linked technology templates. + +![Studio Solutions](./studio-solutions.png) + +The solution document format is described in the [solutions guide](/solutions). diff --git a/docs/studio/studio-dashboard.png b/docs/studio/studio-dashboard.png new file mode 100644 index 0000000..b00f349 --- /dev/null +++ b/docs/studio/studio-dashboard.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:345b0c75103620bb331fd074bc906319ef459f825020c9b41f7aad71238baaf5 +size 856885 diff --git a/docs/studio/studio-desktop.png b/docs/studio/studio-desktop.png new file mode 100644 index 0000000..b1f15bc --- /dev/null +++ b/docs/studio/studio-desktop.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8d637a24f1dd3f87c52abe623f51c9fc583c8f31a06507b9055766cea9fd30e2 +size 911606 diff --git a/docs/studio/studio-footer.png b/docs/studio/studio-footer.png new file mode 100644 index 0000000..18300a0 --- /dev/null +++ b/docs/studio/studio-footer.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8aa27c55c589a504cf670d54d012662162eddaf5fa63085656b40a2ad21d8eb9 +size 37139 diff --git a/docs/studio/studio-header.png b/docs/studio/studio-header.png new file mode 100644 index 0000000..e639b26 --- /dev/null +++ b/docs/studio/studio-header.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:84036cbd0e2df508893c42250fee6c40e1b1cf67647c73bb56c1566959fc5926 +size 69288 diff --git a/docs/studio/studio-modules.png b/docs/studio/studio-modules.png new file mode 100644 index 0000000..3f319bd --- /dev/null +++ b/docs/studio/studio-modules.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:24da1a9ccce7ac966a85f21fb156cc7f1df8622a5f0add1595fdec7beea4f1f4 +size 866647 diff --git a/docs/studio/studio-monitor.png b/docs/studio/studio-monitor.png new file mode 100644 index 0000000..0f8c075 --- /dev/null +++ b/docs/studio/studio-monitor.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ed6dcfca9106b311a2588ec0da7a98bc31b4653f4a3fa07ffcc128c8ea5a5b98 +size 794416 diff --git a/docs/studio/studio-new-docs.png b/docs/studio/studio-new-docs.png new file mode 100644 index 0000000..2e2a7d8 --- /dev/null +++ b/docs/studio/studio-new-docs.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e908245994253f17c2b739a894bf02a859e4f0cf6cf8e6a14ddb2be1e0cccf41 +size 160620 diff --git a/docs/studio/studio-projects.png b/docs/studio/studio-projects.png new file mode 100644 index 0000000..b1f15bc --- /dev/null +++ b/docs/studio/studio-projects.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8d637a24f1dd3f87c52abe623f51c9fc583c8f31a06507b9055766cea9fd30e2 +size 911606 diff --git a/docs/studio/studio-settings.png b/docs/studio/studio-settings.png new file mode 100644 index 0000000..e54c568 --- /dev/null +++ b/docs/studio/studio-settings.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c9ebafe0504e39a94545078b09fb8879175aea481993f5419089005667e6e3e8 +size 802363 diff --git a/docs/studio/studio-simulations.png b/docs/studio/studio-simulations.png new file mode 100644 index 0000000..e8f72bc --- /dev/null +++ b/docs/studio/studio-simulations.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1a649dd5300fb9f3462f846f646238bc44015c760dd168a03626d0f1948426a7 +size 913172 diff --git a/docs/studio/studio-solutions.png b/docs/studio/studio-solutions.png new file mode 100644 index 0000000..082513b --- /dev/null +++ b/docs/studio/studio-solutions.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a398eb49557ecba0a1272e43dfd22cf94ac000a4a2c747f8e2b12672ee0a1feb +size 842305 diff --git a/docs/studio/studio-templates.png b/docs/studio/studio-templates.png new file mode 100644 index 0000000..4138f94 --- /dev/null +++ b/docs/studio/studio-templates.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0fe395b7823994f4da8fe7f0b32b59dd02730f83ca3ab8e58f0353f6aac9d6c0 +size 912655 diff --git a/docs/studio/templates.md b/docs/studio/templates.md new file mode 100644 index 0000000..f803b9c --- /dev/null +++ b/docs/studio/templates.md @@ -0,0 +1,13 @@ +# API Templates + +The API Templates view shows you all the API templates in the project or available from the cloud. You can install, update or remove the templates. + +These templates are listed at the ApiGEar template server and can be used to generate the source code for your API modules. + +To install your local custom templates, click the `Local Template` button and select the template package to be installed. + +The installed packages are then available for your solutions to be used. + +The currently available templates are listed in the [SDK Templates](/sdks) section. + +If you are interested to create your own template or extend an existing template, please read the [template guide](/maker).