Create your first OpenAPI Route
Configure route information
Welcome to this new tutorial to create your first OpenAPI route.
Select your openapi.json
file.
Now, click on Create route
Fill all the route information you need to set up your route.
You need to fill the following fields : path
, operationID
and the Method
You can show on the screenshot below the mandatory route information
Add plugins
Now let's add plugins to your route.
Click on Add plugin
to start adding your first plugin
Then select the plugin you would like to use
For example, we chose the Additional headers out
You can edit its config as you want.
In our example, we've added two headers hello
and demo
Before validating your plugin configuration you need to check it.
To do this, click on Check and validate config
If you see a success message such as Config checked successfully
, your plugin configuration has been validated, you can now click on Add plugin
The Add plugin
button will be filled with a green background if your configuration is validated
Now you added your first plugin, congratulations !
Add as many plugins as you need for route.
Final Step
Your route is now created, your plugins are added to your route and your backend has been linked to the route.
Do not forget to push your changes to github and deploy your project to start using your newly created routes !