Download the PHP package myparcelcom/api-specification without Composer
On this page you can find all versions of the php package myparcelcom/api-specification. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download myparcelcom/api-specification
More information about myparcelcom/api-specification
Files in myparcelcom/api-specification
Package api-specification
Short Description MyParcel.com API specification based on the OpenAPI Specification.
License
Homepage https://api-specification.myparcel.com
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package api-specification
MyParcel.com API specification
Description of the API specification used by MyParcel.com located at https://api-specification.myparcel.com. This specification adheres to the OpenApi 3.1 specification and implements the JSON API specification.
Content
- Installation
- Commands
- Conventions
- License
Installation
The repository provides Docker containers to validate and preview the spec before committing changes. This is also used when validating pull requests. To install Docker, follow the steps in the documentation.
To set up the project for development run:
Commands
./mp.sh up - Start the containers which will start a server to watch file changes and reload automatically.
./mp.sh down - Stop the containers.
./mp.sh validate - Validate the specification.
NOTE: The validator only works when the containers are already running. Don't forget to start them.
Conventions
Conventions based on the Swagger and JSON Schema specs.
Our internal conventions are described below.
PUT, POST, PATCH
To avoid discussion, the use of the above HTTP methods is described below.
PUT
- Used to create or replace a resource.
- Always returns the same response on repeated requests.
- Needs the full resource for the request (including the id for the to be created or replaced resource).
POST
- Used to create a resource.
- Does not return the same response on repeated requests.
- Does not need the full resource for the request (often does not need the id for the to be created resource).
PATCH
- Used to update an existing resource.
- Does not return the same response on repeated requests.
- Does not need the full resource for the request (you might only want to update a user's name for example).
API versioning
The API versioning follows semantic versioning. The increment in version number is done manually and should be part of the pull request.
Schema file naming
Definition file names follow PascalCasing. Where every first letter of a word (including the first word) is uppercase. For example, the definition for a country code would be found in:
Path file naming
The files in specification/paths are named after their corresponding API endpoints. Where resources start with an uppercase letter and path variables with a lowercase letter. For example, the definition of the following route:
can be found in:
Parameter file naming
Parameter file names are prefixed with the corresponding parameter type. A path parameter for carrier_id would get the following file path:
Unique parameters can just remain in the path file and do not need to be extracted to their own files.
License
All software by MyParcel.com is licensed under the MyParcel.com general terms and conditions.
