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

laravelswaggerize

v1.0.0

Published

A command-line tool for converting JSON exported by Insomnia or postman to Swagger format, as well as converting a swagger-formatted json file into a swagger-formatted annotation to facilitate documentation generation.

Downloads

3

Readme

Swaggerize

Introduction

Swaggerize simplifies the process of converting exported JSON from Insomnia or Postman into Swagger documentation for Laravel projects. This tool allows for the generation of Swagger JSON files or PHP annotations, providing flexibility based on project requirements.

Installation

Make sure you have Node.js installed on your machine. Then, install Swaggerize globally:

npm install -g swaggerize

Usage

Testing and Exporting Requests:

Test your API endpoints using Insomnia or Postman. Export requests to JSON format and save the file in your Laravel project’s root directory.

Generating Documentation:

Navigate to your Laravel project directory and run the following command:

swaggerize -doc exported_file.json

Respond to the prompt regarding annotations with “yes” or “no”. If annotations are generated, they’ll be saved in app/Http/Controllers/Annotations/. Use the namespace from each annotation file in the corresponding controller.

Viewing Swagger Documentation:

To view Swagger documentation in your Laravel project, use tools like Darkaonline/L5-Swagger. Install L5-Swagger by running:

swaggerize install

Path Parameters:

Provide values for path parameters in Insomnia or Postman by adding parameters with the same name as those in your routes, enclosed in curly braces {}. For example, if you have a route defined as /users/{userId}, add a parameter named userId with the value you want to test.

Testing with Files and Multipart Support:

  • Uploading Files: Use multipart/form-data in Insomnia or Postman to upload files.

  • Multipart Requests: Configure requests with multipart/form-data to send multiple types of data.

Update Swaggerize:

To update Swaggerize to the latest version, run:

swaggerize update

License

This package is licensed under the MIT License. See LICENSE.md for details.