Document

Luna API

Write, Document, Publish

Start LunaAPIDocGen:

This program can be found at https://github.com/eurog33k/LunaAPIDocGen, and is used to document API calls and translate them into JSON so that we can transfer the documentation definition to the project that will do the Unit Tests and generate our swagger.json file (LunaAPI2Swagger). NOTE: the apidocsluna.db from the externals folder needs to be placed under SpecialFolder.ApplicationData

Document the API Call:

• Fill in the API call (start the API path with a /)

• Use a PATH parameter (e.g. /apipath/{pathparameter} ) if required.

• Adjust the necessary fields.

• After filling in all the necessary fields, press save to store the API definition

Click here for our step by step guide

Transfer the documentation:

To transfer an API call to the swagger documentation generation project, select the api call, select the LunaAPI2Swagger.xojo_binary_project file and press the send to project button.

If your forgot to select the project file, the file dialog will open to allow you to select the project.