medusa-plugin-static-pages

0.1.7 • Public • Published

medusa-plugin-static-pages

Provides a basic static pages backend for Medusa.

Documentation

If you are not familiar with Medusa, you can learn more on the project web site.

Medusa is a set of commerce modules and tools that allow you to build rich, reliable, and performant commerce applications without reinventing core commerce logic. The modules can be customized and used to build advanced ecommerce stores, marketplaces, or any product that needs foundational commerce primitives. All modules are open-source and freely available on npm.

This plugin is under development and should be considered experimental.

Breaking changes are very likely to occur.

Features

  • Pages can be queried by handle or id.
  • CRUD pages will be display at admin side

Add Plugin Configuration

To pass a plugin its configurations on a Medusa backend, you have to add it to the plugins array in medusa-config.js:

const plugins = [
  // ...
  {
    resolve: "medusa-plugin-static-pages",
    options: {
      enableUI: true,
    },
  },
]

API Endpoints

GET /store/pages

return jsons object containing an array of all page objects

GET /store/page/:handle

return json object containing a single page object with given handle

GET /store/page/:id

return json object containing a single page object with given id

POST /admin/page

create a new page object Expects body with:

{
   handle: string!,
   title: string!,
   metadata: string,
   body: string
}

POST /admin/page/:id

update an existing page object with given id Expects body with:

{
   handle: string!,
   title: string!,
   metadata: string,
   body: string
}

DELETE /admin/page/:id

delete an existing page object with given id

Objects

Page

{
   id: string!,
   handle: string!,
   title: string!,
   metadata: string,
   body: string,
   created_at: DateTime!,
   updated_at: DateTime!
}

Package Sidebar

Install

npm i medusa-plugin-static-pages

Weekly Downloads

8

Version

0.1.7

License

MIT

Unpacked Size

449 kB

Total Files

30

Last publish

Collaborators

  • abdullah-afzal
  • mawais022