An Example JSON API for Perfect
Swift
Latest commit 30dafb9 Dec 22, 2016 @RockfordWei RockfordWei committed on GitHub Merge pull request #1 from Moon1102/master
中文文档

README.md

Perfect JSON API Example 简体中文

Get Involed with Perfect!

Star Perfect On Github Stack Overflow Follow Perfect on Twitter Join the Perfect Slack

Swift 3.0 Platforms OS X | Linux License Apache PerfectlySoft Twitter Slack Status

An Example JSON API for Perfect

This package builds with Swift Package Manager and is part of the Perfect project.

Ensure you have installed Xcode 8.0 or later.

Setup - Xcode 8

  • Check out or download the project;
  • In terminal, navigate to the directory and execute
swift package generate-xcodeproj
  • Open Perfect-JSON-API.xcodeproj
  • Add to the "Library Search Paths" in "Project Settings" $(PROJECT_DIR), recursive. (This step will be unneeded in a future release of Xcode 8.)
  • Select the Executable build target from the build targets dropdown in Xcode
  • Run (cmd-R) to build & run in Xcode.

In Xcode's console output pane you will see:

[INFO] Starting HTTP server on 0.0.0.0:8181 with document root ./webroot

Setup - Terminal

  • Check out or download the project;
  • In terminal, navigate to the directory
  • Execute swift build
  • Once the project has compiled, execute ./.build/debug/Perfect-JSON-API

The output you will see:

[INFO] Starting HTTP server on 0.0.0.0:8181 with document root ./webroot

Included Routes

The following routes are included in this API for demonstration purposes:

{
    "email": "test@example.com",
    "firstName": "Test",
    "lastName": "User"
}

Postman Collection

The repo includes a file Example-PeopleAPI.postman_collection which is a Postman URL collection.

With Postman installed, import and use to easily query the routes.

Issues

We are transitioning to using JIRA for all bugs and support related issues, therefore the GitHub issues has been disabled.

If you find a mistake, bug, or any other helpful suggestion you'd like to make on the docs please head over to http://jira.perfect.org:8080/servicedesk/customer/portal/1 and raise it.

A comprehensive list of open issues can be found at http://jira.perfect.org:8080/projects/ISS/issues

Further Information

For more information on the Perfect project, please visit perfect.org.