Showing results for 
Search instead for 
Did you mean: 

Swagger for FTP endpoints

Regular Visitor

Swagger for FTP endpoints

We are working with a number of legacy systems that still sends and receives information via FTP. We have put in place transformations to move these FTP sites and migrate them into S3 buckets in AWS. However, the FTP locations will still need to exist for the immediate future. We want to document these locations and provide information such server address, directory location, protocol, file extensions accepted, file formating, etc. My hope is to use render doc to generate Swagger files but in a way that allows the fitting of FTP instead of just REST calls. The desire is we want to keep an online documentation for the old style of FTP locations and the new style of REST endpoints together in one place. Anyway, I have searched and haven't found much out there trying to do similar. Is Swagger flexible enough to handle this similar but different type of endpoint? If so, suggestions on where to start would be great.


OpenAPI Specification and Swagger tools are for HTTP-based APIs only and do not support other protocols like FTP.

Helen Kosova
SmartBear Documentation Team Lead
Learn SmartBear products in a fun and easy way and prove your knowledge!
>>Participate in the TechCorner Challenge today
New Here?
Join us and watch the welcome video:
Top Kudoed Authors