https://github.com/perfectlysoft/perfect-webredirects
Filter for specified routes (including trailing wildcard routes) and perform redirects as instructed if a match is found.
https://github.com/perfectlysoft/perfect-webredirects
http-server server-side-swift swift
Last synced: 12 months ago
JSON representation
Filter for specified routes (including trailing wildcard routes) and perform redirects as instructed if a match is found.
- Host: GitHub
- URL: https://github.com/perfectlysoft/perfect-webredirects
- Owner: PerfectlySoft
- Created: 2017-02-05T21:47:20.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-02-10T04:08:25.000Z (over 8 years ago)
- Last Synced: 2025-06-21T07:46:23.249Z (about 1 year ago)
- Topics: http-server, server-side-swift, swift
- Language: Swift
- Homepage: https://github.com/PerfectExamples/Perfect-WebRedirects-Demo
- Size: 11.7 KB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Perfect Web Redirects
## Perfect Web Redirects Demo
The Perfect WebRedirects module will filter for specified routes (including trailing wildcard routes) and perform redirects as instructed if a match is found.
A demo showing the usage, and working of the Perfect WebRedirects module can be found at [https://github.com/PerfectExamples/Perfect-WebRedirects-Demo](https://github.com/PerfectExamples/Perfect-WebRedirects-Demo).
## Including in your project
Import the dependency into your project by specifying it in your project's Package.swift file, or adding it via Perfect Assistant.
``` swift
.Package(url: "https://github.com/PerfectlySoft/Perfect-WebRedirects", majorVersion: 3),
```
Then in your `main.swift` file where you configure your web server, add it as an import, and add the filter:
``` swift
import PerfectWebRedirects
```
Adding the filter:
``` swift
// Add to the "filters" section of the config:
[
"type":"request",
"priority":"high",
"name":WebRedirectsFilter.filterAPIRequest,
]
```
If you are also adding Request Logger filters, if the Web Redirects object is added second, directly after the RequestLogger filter, then both the original request (and it's associated redirect code) and the new request, will be logged correctly.
## Configuration file
The configuration for the routes is included in JSON files at `/config/redirect-rules/*.json` in the form:
```
{
"/test/no": {
"code": 302,
"destination": "/test/yes"
},
"/test/no301": {
"code": 301,
"destination": "/test/yes"
},
"/test/wild/*": {
"code": 302,
"destination": "/test/wildyes"
},
"/test/wilder/*": {
"code": 302,
"destination": "/test/wilding/*"
}
}
```
Note that multiple JSON files can exist in this directory - all will be loaded the first time the filter is invoked.
## Compatibility with Swift
The master branch of this project currently compiles with **Xcode 9** or the **Swift 4** toolchain on Ubuntu.
## Further Information
For more information on the Perfect project, please visit [perfect.org](http://perfect.org).