MailBaby API
API service for accessing the Mail.Baby services.
API Sample Clients
Sample clients for the API are available in many languages
Development
This is built on top of Webman, a high performance HTTP Service Framework for PHP based on Workerman.
API Specification
We are utilizing the OpenAPI (formerly known as Swagger) spec for this API. It is basically the next evolution of SOAP API’s with well defined functions, parameters, and responses. While there are many editors out there I’m currently using SwaggerHub to do most of the editing of the spec.
Webman Framework
After testing every PHP library out there dealing with concurrent/asynchronous processing many times over the years I’ve found Workerman to be the overall best. It has proven more stable and by far faster than the alternatives with the one big downside being that its documentation and code comments are all in Chinese. Webman is a fairly recently created web framework on top of Workerman. There had been many previously created frameworks based on workerman and while some were good Webman seemed to hit that perfect balance between ease-of-use and power.
The Chinese documentation is easily readable Using either the auto translate in Chrome or an addon like Translate Web Pages for Firefox.
- WebMan Manual WebMan framework documentation
Documentation
- Illuminate Database Docs
- StopLight Elements OpenAPI Documentor
- MailBaby Swagger-UI
- MailBaby generator HTML2 Docs
- MailBaby generated PHP Client PHP Client generated by the OpenAPI Generator/Swagger Codegen
- Redoc – OpenAPI/Swagger-generated API Reference Documentation
- RapiDoc – Custom-Element for OpenAPI Spec
- OpenDocumenter is a automatic documentation generator for OpenAPI v3 schemas. Simply provide your schema file in JSON or YAML, then sit back and enjoy the documentation.
- OpenAPI Explorer – OpenAPI Web component to generate a UI from the spec.
- oas3-api-snippet-enricher Enrich your OpenAPI 3.0 JSON with code samples
- OpenAPI-Viewer – OpenApi viewer Implemented using Vue
- LucyBot Documentation Starter – Interactive REST API Documentation
Building Elements:
git clone git@github.com:stoplightio/elements.git
cd elements && \
nvm use;
dst="https://raw.githubusercontent.com/interserver/mailbaby-mail-api/master/public/spec/openapi.yaml" && \
for src in https://raw.githubusercontent.com/stoplightio/Public-APIs/master/reference/zoom/openapi.yaml https://api.apis.guru/v2/specs/github.com/1.1.4/openapi.yaml; do
grep -r $src -l | xargs -n 1 sed s#"$src"#"$dst"#g -i
done && \
yarn && \
yarn build && \
for i in angular react-gatsby react-cra static-html; do
yarn copy:$i && \
yarn build:$i
done
Code Samples
TODO
- Customize 404 Page
- Testing
- Additional error checking and handling
- Auto Updates
- Placing Orders
URLs of interest in this project
- OpenAPI Tools Listing of OpenAPI relatd tools by category (Documentors, Parsers, Mockers, etc)
- OpenAPI PSR-7 Message Validator
- PHPMailer email sending library for PHP
- Swagger UI
- Swagger Editor
- OpenAPI GUI
LICENSE
MIT