Home

Welcome to the api2excel_repo wiki!

This project is mainly designed for generating the user documentation using an API articraft (WSDL, or Swagger). User documentation format is Excel (XLS or XLSX).

API is normally designed to serve specific purpose i.e. functionality and thus accepts certain parameters (inputs) and provide a certain result (i.e. response) which is optional.

So the documentation for both WSDL and Swagger (REST) APIs will have "Request" and "Response" sheets at the minimum.

How the documentation is generated for WSDL file? --> For each operation in WSDL file, one API document is generated. --> Each Request and Response will have the following fields/columns. --> 1. Field Name --> 2. Data Type --> 3. Cardinality (Mandatory/Optional/Repeating) --> 4. Description (Annotations in XSD - documentation for elements/types) --> 5. X-Path

How the documentation is generated for Swagger file?