The latest version of Apache and the Swagger Editor combined in a single package to make working with the Swagger Editor web application easier. The Swagger Editor is a web application, designed to work in a web browser deployed on a server. The ApacheHttpdSwagger application allows you to quickly and easily create a local server and take advantage of native Swagger features and best practices. Some of these best practices are based on http requests for additional Swagger component files. Leveraging a component set of reusable Swagger definition files is especially helpful and a best practice when Swagger files start to become large. With large files maintenance and extension becomes a more difficult task, prone to higher risk, in real world application of Swagger API definition file(s).
__This project aims to make things better, and easily leverage the best of what the Swagger Editor has to offer in an open source standard. Enjoy! 👍😊
This cookbook describes how to install the Apache Swagger Editor on your local workstation. This is important as the Swagger Editor while functional to a limited degree on your local file system in a web browser is designed to be a web application running on a web server. This is important to take advantage of features such as http references from Swagger files to other modular or shared Swagger json files by design, respectfully. This modular pattern allows for better maintenance of more complex Swagger files and results in smaller more manageable Swagger components. Further, true sharing of definitions between Swagger files allows for full automatic synchronicity of key standards that are designed to be synchronized at all times between Swagger files as major version shared standards. The goal is to follow Swagger best practices, and also simplify and improve maintenance and modification of the Swagger files over time.
- Download the latest distro. It is located in ApacheHttpdSwagger-1.0/distro/Windows-10-64bit/ directory.
- Find the latest version and download. All distros are date coded for easy references to different distros over time.
- Unzip the zip file, you will see a directory called "Apache Software Foundation".
- Copy the "Apache Software Foundation" folder to the following path:
C:\Program Files\ - Open a command prompt and type the following commands:
CD "C:\Program Files\Apache Software Foundation\Apache 2.4\bin" [press enter]httpd.exe -k install [press enter]
- Open your favorite web browsers, and enter the following URL:
- You should see the Swagger Editor load!
- Bookmark this page as your local Swagger Editor 👍😊✌️
NOTE: With this configuration, the Apache Swagger Editor is running as a Service in your Windows installation. This means it will automatically started and available when you turn on your workstation.
- Apache 2.4 is a lightweight process at runtime, and you should see no performance differences on your local computer with the service running.
- If you want to change the service configuration at any time, launch the Services Desktop app. To do this easily on Windows 10 click on the Cortana button in your task bar, and type "Services" in the Cortana search box. Cortana will find the "Services Desktop app" - select this to launch.
- In the Services window, you will see the "Apache2.4" Service. From here you can right click to set different start options, manually restart the service if there are configuration changes, etc.
Configure the Work Mod (aka WorkMod.conf):
Directory browsing is also enabled in this configuration so that you can quickly confirm the web server / browser view of your local Swagger files. You can modify your Swagger files in your file system editor of choice, save, then hit reload in the web browser and see your changes instantly reflected. You can configure Apache to reference any location in your local workstation. To change the path, refer to the following instructions for your work directory path.
- The WorkMod.conf is installed by default.
- You can modify the path to your work directory by editing the WorkMod.conf file with the appropriate path to your desired work directory. The file is located in the Apache Software Foundation/Apache 2.4/conf/mods directory.
- NOTE: Typically the path to the work directory would be the directory where your Swagger files are located, but can be any location on your file system that you have access to read.
All Mod.conf files should be placed in the conf/mods/ directory. These will automatically be referenced at Server start time or restart time.