chore: add OpenAPI docs and custom HTTP Port

Author: mathiasgheno

README.md

@@ -14,4 +14,14 @@ After that you can start the server throught that:
 
 ```shell
 npm run start
-```
+```
+
+The default port is `3000`. If you want to run it in other port you can define the `PORT` environment variable. 
+
+```shell
+PORT=3008 npm run start
+```
+
+### Docs
+
+You can access the path `/docs` to get access to Swagger Docs.

index.js

@@ -1,19 +1,89 @@
 import express from 'express';
 import cors from 'cors';
 import {getArticleMetaData} from 'article-metadata-extractor';
+import swagger from 'swagger-ui-express';
 
 const app = express();
 
 app.use(cors());
 
+const docs = {
+  openapi: '3.0.0',
+  paths: {
+    "/": {
+      "get": {
+        "tags": ["Extractor"],
+        "summary": "",
+        "description": "",
+        "parameters": [
+          {
+            "name": "url",
+            "in": "query",
+            "description": "Article's URL you want to extract some data",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uri"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "application/json": {
+                "example": {
+                  "image": "https://www.designyourway.net/blog/wp-content/uploads/2015/03/XJbzrO.jpg",
+                  "title": "116 Cool CSS Text Effects Examples That You Can Download",
+                  "author": "Bogdan Sandu",
+                  "tags": [],
+                  "publicationDate": "2023-04-19T11:00:12.000Z",
+                  "readTime": 29,
+                  "description": "You came here for some really cool CSS text effects that will help you make amazing web typography for your websites.",
+                  "url": "https://www.designyourway.net/blog/yes-you-can-actually-make-these-text-effects-in-css/?utm_source=pocket_saves"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {
+                "example": {
+                  "error": "Invalid URL"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "content": {
+              "application/json": {
+                "example": {
+                  "error": "Ocorreu um erro interno"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+};
+
+app.use('/docs', swagger.serve, swagger.setup(docs))
+
 app.get('/', (req, res) => {
   const {query} = req;
   if(!query?.url) {
-    return res.status(400).send('Should defined query params url');
+    const error = 'Should defined query params url';
+    return res.status(400).send({error});
   }
   getArticleMetaData(query.url)
     .then((data) => res.json({...data, url: query.url}))
-    .catch((erro) => res.status(500).send(erro));
+    .catch((error) => res.status(500).send({error}));
 });
 
-app.listen(3000, () => console.log('running'));
+const port = process.env.PORT || 3000
+
+app.listen(port, () => console.log(`running at ${port}`));

package-lock.json

@@ -13,7 +13,8 @@
   "dependencies": {
     "article-metadata-extractor": "^1.3.2",
     "cors": "^2.8.5",
-    "express": "^4.18.2"
+    "express": "^4.18.2",
+    "swagger-ui-express": "^5.0.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.18"