FaUAPI DevOps Pipeline tasks has a sequence of excecution that must be adhered to when creating your FaUAPI DevOps pipeline. For example, to configure backend, you must have named values configured an so forth. Hence, the required FaUAPI DevOps pipeline flow can be described as follows:
Configuring API Named Values -> Configuring API Backends -> Configuring an API -> Configuring an API Policy -> Publishing an API
This sequence for using the FaUAPI DevOps Pipeline tasks extension in your DevOps pipeline is summarised in the table below:
| Task | DevOps Task Name | Preceeding Tasks | Notes | |
|---|---|---|---|---|
| Configuring Named Values | FaUAPI-Configure-Named-Values | N/A | This DevOps pipeline task configure Named values which are useful for creating shared variables including email address and secret keys that can be reused across APIs within a workspace and used by API policies. Within a Pipeline with multiple tasks, this task will need to be performed first as it is required to configured backends and API policy which may have references to Named Values. | |
| Configuring Backends | FaUAPI-Configure-Backends | FaUAPI-Configure-Named-Values | This DevOps pipeline task will configure Backends for an API which is the location address of the backend server for the hosted API environment. | |
| Configuring an API | FaUAPI-ConfigureApi | FaUAPI-Configure-Named-Values -> FaUAPI-Configure-Backends | This DevOps pipeline task will to configure and create a new API or update the configuration of an existing an API. | |
| Configuring an API policy. | FaUAPI-Configure-Api-Policy | FaUAPI-Configure-Named-Values -> FaUAPI-Configure-Backends -> FaUAPI-ConfigureApi | This DevOps pipeline task will configure the policy for an API. | |
| Publishing an API | FaUAPI-Publish-Api | FaUAPI-Configure-Named-Values -> FaUAPI-Configure-Backends -> FaUAPI-ConfigureApi FaUAPI-Configure-Api-Policy | This DevOps pipeline task will publish an API to the relevant instance. |
Unpublishing an API (FaUAPI-Unpublish-Api) has been left out of the FaUAPI DevOps pipeline tasks sequence due to the fact an API can only be unpublished after it has been published. Therefore, any FaUAPI DevOps pipeline task will be on the basis that a published API exist.