From c260bdfa3d3ccc9d6c704d35180be1c3d2310192 Mon Sep 17 00:00:00 2001 From: Herbert Lu <15816537946@163.com> Date: Thu, 3 Jun 2021 10:14:29 +0800 Subject: [PATCH 1/2] DOC: readme add api doc --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 20870a7e..22ead230 100644 --- a/README.md +++ b/README.md @@ -154,6 +154,14 @@ func main() { For more detailed documentation, please check on godoc.org 👉 [email-verifier](https://godoc.org/github.com/AfterShip/email-verifier) +## API + +We provide a simple **self-hosted** [API server](https://github.com/AfterShip/email-verifier/tree/main/cmd/apiserver). + +Using the API is very simple. All that's needed to verify an email address is to send a GET request using the below URL. + +`https://{your_host}/v1/{email}/verification` + ## Similar Libraries Comparison | | [email-verifier](https://github.com/AfterShip/email-verifier) | [trumail](https://github.com/trumail/trumail) | [check-if-email-exists](https://reacher.email/) | [freemail](https://github.com/willwhite/freemail) | @@ -176,8 +184,8 @@ For more detailed documentation, please check on godoc.org 👉 [email-verifier] | Honeyport dection | 🔜 | ❌ | ❌ | ❌ | | Bounce email check | 🔜 | ❌ | ❌ | ❌ | | **Tech** | 〰️ | 〰️ | 〰️ | 〰️ | -| Provide API | 🔜 | ✅ | ✅ | ❌ | -| Free API | 🔜 | ❌ | ❌ | ❌ | +| Provide API | ✅ | ✅ | ✅ | ❌ | +| Free API | ✅ | ❌ | ❌ | ❌ | | Language | Go | Go | Rust | JavaScript | | Active maintain | ✅ | ❌ | ✅ | ✅ | | High Performance | ✅ | ❌ | ✅ | ✅ | From f1381b10437fe8dc8e2a5a68d567b339c4db506c Mon Sep 17 00:00:00 2001 From: Bossa Wong Date: Thu, 3 Jun 2021 10:34:52 +0800 Subject: [PATCH 2/2] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 22ead230..40b4ae63 100644 --- a/README.md +++ b/README.md @@ -156,9 +156,11 @@ For more detailed documentation, please check on godoc.org 👉 [email-verifier] ## API -We provide a simple **self-hosted** [API server](https://github.com/AfterShip/email-verifier/tree/main/cmd/apiserver). +We provide a simple **self-hosted** [API server](https://github.com/AfterShip/email-verifier/tree/main/cmd/apiserver) script for reference. -Using the API is very simple. All that's needed to verify an email address is to send a GET request using the below URL. +The API interface is very simple. All you need to do is to send a GET request with the following URL. + +The `email` parameter would be the target email you want to verify. `https://{your_host}/v1/{email}/verification`