Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/interserver/mailbaby-mail-api

API Server for the MailBaby Email Services.
https://github.com/interserver/mailbaby-mail-api

email openapi openapi3 webman webman-framework workerman

Last synced: 2 days ago
JSON representation

API Server for the MailBaby Email Services.

Host: GitHub
URL: https://github.com/interserver/mailbaby-mail-api
Owner: interserver
License: mit
Created: 2022-09-21T07:13:45.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-04-11T17:13:17.000Z (10 months ago)
Last Synced: 2024-04-11T22:04:57.692Z (10 months ago)
Topics: email, openapi, openapi3, webman, webman-framework, workerman
Language: PHP
Homepage:
Size: 6.24 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: support/Request.php

Awesome Lists containing this project

README

        # MailBaby API

API service for accessing the Mail.Baby services.

# API Sample Clients

Sample clients for the API are available in many languages

* https://github.com/interserver/mailbaby-api-samples

# Documentation

* Lists

  * [OpenAPI Tools](https://openapi.tools/) Listing of OpenAPI relatd tools by category (Documentors, Parsers, Mockers, etc)

* Framework Docs

  * [WebMan Manual](https://www.workerman.net/doc/webman) WebMan framework documentation

  * [Illuminate Database Docs](https://laravel.com/docs/8.x/queries)

  * [PHPMailer](https://github.com/PHPMailer/PHPMailer/) email sending library for PHP

* API Spec

  * [raw.githubusercontent.com/interserver/mailbaby-mail-api/master/public/spec/openapi.json](https://raw.githubusercontent.com/interserver/mailbaby-mail-api/master/public/spec/openapi.json)

  * [mynew.interserver.net:8787/spec/openapi.json](http://mynew.interserver.net:8787/spec/openapi.json)

* API Client Sample Generators

  * [swagger-api/swagger-codegen: swagger-codegen contains a template-driven engine to generate documentation, API clients and server stubs in different languages by parsing your OpenAPI / Swagger definition.](https://github.com/swagger-api/swagger-codegen)

  * [OpenAPITools/openapi-generator-cli: A node package wrapper for https://github.com/OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator-cli)

    * [Generators List | OpenAPI Generator](https://openapi-generator.tech/docs/generators)

  * [Kong/httpsnippet: HTTP Request snippet generator for many languages & libraries](https://github.com/Kong/httpsnippet)

* Code Snippet and Example integration into SPEC

  * [cdwv/oas3-api-snippet-enricher: Enrich your OpenAPI 3.0 JSON with code samples](https://github.com/cdwv/oas3-api-snippet-enricher/)

  * [ErikWittern/openapi-snippet: Generates code snippets for given Swagger / Open API documents](https://github.com/ErikWittern/openapi-snippet)

  * Generated Code

  * [MailBaby generated PHP Client](https://github.com/interserver/mailbaby-client-php) PHP Client generated by the OpenAPI Generator/Swagger Codegen

* Our API Docs

  * [MailBaby Swagger-UI](https://api.mailbaby.net/doc/index.html)

  * [MailBaby API Documentation](https://www.mail.baby/apidoc.html#/operations/addRule)

  * [Swagger UI](http://mynew.interserver.net:8787/doc/index.html)

  * [MailBaby API Documentation](http://mynew.interserver.net:8787/elements.html#/)

  * [mynew.interserver.net:8787/rapidoc.html#overview](http://mynew.interserver.net:8787/rapidoc.html#get-/mail/rules)

  * [ReDoc](http://mynew.interserver.net:8787/redoc.html#tag/Services)

  * [mynew.interserver.net:8787/openapi-explorer.html#?route=get-/mail](http://mynew.interserver.net:8787/openapi-explorer.html#?route=post-/mail/advsend)

* API Editor

  * [SwaggerHub editor for MailBaby API Spec](https://app.swaggerhub.com/apis/InterServer/MailBaby/1.0.0)

  * [Apicurio Studio - API Editor :: MailBaby Email Delivery and Management Service API](https://studio.apicur.io/apis/93974/editor)

  * [Apicurio Studio - API Editor :: my InterServer Services Management API](https://studio.apicur.io/apis/93618/editor)

* PHP OpenAPI Libs

  * [canvural/php-openapi-faker: Library to generate fake data for OpenAPI request/response/schemas](https://github.com/canvural/php-openapi-faker)

  * [sunrise-php/http-router: :tada: Release 2.0 is released! Very fast HTTP router for PHP 7.1+ based on PSR-7 and PSR-15 with support for annotations/attributes and OpenAPI (Swagger) Specification](https://github.com/sunrise-php/http-router)

  * [cebe/php-openapi: Read and write OpenAPI yaml/json files and make the content accessible in PHP objects.](https://github.com/cebe/php-openapi)

  * [lezhnev74/openapi-psr7-validator: It validates PSR-7 messages (HTTP request/response) against OpenAPI specifications](https://github.com/lezhnev74/openapi-psr7-validator)

  * [erasys/openapi-php: 📚Swagger / Open API 3.0 builder and validation library for PHP that helps you write valid specs.](https://github.com/erasys/openapi-php)

  * [OpenAPI PSR-7 Message Validator](https://github.com/thephpleague/openapi-psr7-validator)

* API Doc Settings

  * [Swagger/OpenAPI Spec Documentation](https://swagger.io/docs/specification/describing-responses/)

  * [StopLight Elements](https://github.com/stoplightio/elements) OpenAPI Documentor

  * [rapi-doc/RapiDoc: RapiDoc -WebComponent for OpenAPI Spec](https://github.com/rapi-doc/RapiDoc)

  * [RapiDoc - Web Component based Swagger & OpenAPI Spec Viewer](https://rapidocweb.com/)

  * [stoplightio/studio: The modern editor for API Design and Technical Writing.](https://github.com/stoplightio/studio)

  * [Open-Source API Mocking, Linting, & Documentation | Stoplight](https://stoplight.io/open-source)

  * [RapiDoc - Web Component based Swagger & OpenAPI Spec Viewer](https://rapidocweb.com/api.html)

  * [RapiDoc API Demo](https://rapidocweb.com/examples/api-demo.html#post-/mail/advsend)

# Development

This is built on top of Webman, a high performance HTTP Service Framework for PHP based on [Workerman](https://github.com/walkor/workerman).

## API Specification

We are utilizing the OpenAPI 3 (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](https://github.com/walkor/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](https://github.com/walkor/webman) is a fairly recently created web framework on top of [Workerman](https://github.com/walkor/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](https://addons.mozilla.org/en-US/firefox/addon/traduzir-paginas-web/) for Firefox.