npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

liferay-api-client-gen

v1.1.3

Published

The Liferay Headless API Client Generator is a command-line tool built with Node.js that helps developers discover Liferay Headless APIs and generate client wrappers to consume these APIs. Additionally, the tool provides a feature to generate CSV files fo

Downloads

6

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

tayemmahmoud87tayemmahmoud87

Keywords

Readme

Liferay Headless API Client Generator

The Liferay Headless API Client Generator is a command-line tool built with Node.js that helps developers discover Liferay Headless APIs and generate client wrappers to consume these APIs. Additionally, the tool provides a feature to generate CSV files for each RESTful application, describing the API paths, method names, and parameters.

Installation

To use the Liferay Headless API Client Generator, follow these steps:

  1. Ensure you have Node.js installed on your system. You can download it from the official Node.js website: https://nodejs.org

  2. Open a terminal or command prompt.

  3. Install the Liferay Headless API Client Generator globally by running the following command:

    npm install -g liferay-api-client-gen

    This will install the tool globally, making it accessible from anywhere on your system.

Usage

Once the installation is complete, you can use the Liferay Headless API Client Generator as follows:

  1. Open a terminal or command prompt.

  2. Run the following command to start the tool:

    liferay-code-gen

  3. The tool will prompt you to provide the necessary information to discover the Liferay Headless APIs and generate the client wrappers. Follow the prompts and provide the requested details, such as the Liferay API base URL and authentication credentials.

  4. Once the process is complete, the tool will generate the client wrappers for the discovered APIs, which you can use in your project.

Generate CSV Files

In addition to generating client wrappers, the Liferay Headless API Client Generator provides a feature to generate CSV files for each RESTful application. These CSV files describe the API paths, method names, and parameters.

To generate CSV files, follow these steps:

  1. After starting the tool using the steps mentioned above, choose the option to generate CSV files.

  2. Provide the necessary information, such as the output directory where the CSV files will be generated.

  3. The tool will scan the discovered APIs and generate individual CSV files for each RESTful application, providing detailed information about the API paths, method names, and parameters.

  4. The generated CSV files can be accessed in the specified output directory.