Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
vite-plugin-json-server
Advanced tools
Readme
vite-plugin-json-server
vite-plugin-json-server is a plugin for Vite.js that integrates the json-server library, providing a simple way to serve a mock RESTful API during development. It enables you to quickly set up a server and define JSON data as endpoints, allowing you to simulate backend functionality without the need for a real server. This plugin is designed to seamlessly integrate with Vite.js, leveraging its fast and efficient development server. By combining the power of Vite.js and json-server, you can streamline your frontend development process and focus on building your application.
During frontend development, it is often necessary to work with an API before the actual backend is ready or available. This can cause delays and hinder the development process. With vite-plugin-json-server, you can overcome this hurdle by creating a mock API server with minimal effort. It allows you to define your data, endpoints, and even custom routes, providing a flexible and efficient solution for frontend development.
npm install vite-plugin-json-server --save-dev
or
yarn add vite-plugin-json-server --dev
vite.config.js
file:import jsonServer from "vite-plugin-json-server";
export default {
plugins: [
jsonServer({
// Configuration options
}),
],
};
npm run dev
http://localhost:5173
by default.The plugin supports the following configuration options:
apiPath
: The base path for publishing json-server services. Default value: '/api'.profile
: The profile name as directory name where other files are referenced. It can be used to customize data profile as needed. The default value is an empty string. You can use 'db-dev' or 'db1' as profile names.source
: The resource to load and pass as main parameters to json-server. It is used with join(profile, source)
when compiling.static
: The name of the profile that contains static files. It is derived from join(profile, source)
.unwatch
: An inverse flag for the watch
option that monitors and reloads the server when changes are detected.readOnly
: A flag for json-server to enable read-only mode.bodyParser
: A flag for json-server to enable body parsing.noCors
: A flag for json-server to disable CORS (Cross-Origin Resource Sharing).noGzip
: A flag for json-server to disable Gzip compression.delay
: The delay value for json-server to simulate network latency.id
: The value for json-server's id
option.foreignKeySuffix
: The value for json-server's foreignKeySuffix
option.quiet
: The value for json-server's quiet
option.
Please refer to the json-server documentation for more details on these configuration options.Note: The following options are not yet supported by the plugin and will be implemented in a future version: routes
, snapshots
, and middlewares
.
Note: The host
and port
options are excluded form the plugin.
This plugin is licensed under the MIT License.
FAQs
A plugin that integrates json-server with Vite.js, providing a simple way to mock REST APIs during development.
The npm package vite-plugin-json-server receives a total of 27 weekly downloads. As such, vite-plugin-json-server popularity was classified as not popular.
We found that vite-plugin-json-server demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.