@ecovoit-api/mock-adapter NPM

Mock Adapter

Ecovoit-API Mock Adapter is an axios adapter that mocks the Ecovoit-API v1.0.0-b.7.

Documentation

Ecovoit API docs

Developer preparation guide

As this package should only be used in a development environment, you would probably install it using:

npm install @ecovoit-api/mock-adapter --save-dev

Then, after you've managed to get your axios instance ready to use, inject our axios mock adapter by this way and you should be able to call our API using its real URL, additionnally to all other services on the web:

import axios from "axios";
import EVAPIMockAdapter from "@ecovoit-api/mock-adapter";

const axiosInstance = axios.create(); // You would probably add options.
// After creating the object, it's useless.
const mock = new EVAPIMockAdapter(axiosInstance); 

axiosInstance.get("https://api-ev-qq.pimous.dev/"); // Responded by the mock.
axiosInstance.get("https://api.github.com/"); // Responded by GitHub.

Finally, when you'll be ready to call the real API that's on the web, just remove the line creating the EVAPIMockAdapter object.

License

Ecovoit API (Diagrams, SQL scripts, NPM Packages, PHP API)
Copyright © 2024 - Quantum Quartet (https://www.qq.pimous.dev/)

These programs is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The latters are distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU General Public License and the GNU Lesser General Public License along with the programs (Links: GNU GPL v3 & GNU LGPL v3). If not, see https://www.gnu.org/licenses.