api-scripts
L5-Swagger
api-scripts | L5-Swagger | |
---|---|---|
26 | 4 | |
80 | 2,508 | |
- | - | |
4.5 | 4.8 | |
10 days ago | about 1 month ago | |
JavaScript | PHP | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
api-scripts
- Question on importing from MD files?
-
Migrate from MediaWiki
Not really specific tools for that purpose, but our api-scripts repo has a collection of examples that use the API, which could be used as a basis for building something more specific. Within the readme there is also a variety of more extensive community project, some of which may also be useful here.
-
Download offline version of bookstack site
You could run a script that uses the API to export all content to PDF/HTML. I have a basic example of this here in our API scripts repo.
-
Would like to create documentation for my server - What are the best tools ?
Their Script
- New API Script Example in PowerShell: Create BookStack Pages from HTML Files
-
Homelab Documentation
To add to this, some people script and cron regular exports via the API. I have a basic example script here.
-
How to import markdown via CLI?
Also, if it helps, we have API script examples here and there is an existing bash cli build here.
-
Move to BookStack from WikiJS?
If you wanted accessible non-DB copies of your content, this is possible via a couple of options. Some users script exports of all their books. I have an example of this here in our API script examples repo. Alternatively you could write out raw content to plain files on the system via hooking into events using our logical theme system. I have an basic example of doing this for HTML format content within this blog post.
-
I'm being overwhelmed by text files cataloguing what I've done on various servers
I found this this evening
-
Any self-hosted alternative to Confluence for wikis that comes anywhere close?
Can't give too much advice in regards to Confluence, but in regards to BookStack import the REST API is probably the best best. API docs can be seen on our demo instance here. API usage examples, and community projects/scripts, can be found here if it helps. You might be able to find existing confluence to bookstack scripts. Came across this in a search but not sure how feature complete or up-to-date it is.
L5-Swagger
-
Pragmatic development
First, swagger-php generates openapi.yaml based on code attributes, and then the spectator checks API responses to match openapi specification. The popular L5-Swagger is redundant in this case, as it is based on the same swagger-php with the addition of Swagger UI.
-
What's your go-to API documentation generator
Any particular package? I'm looking for something that will ideally inspect the api.php or controllers, and generator from there. I've found this: https://github.com/DarkaOnLine/L5-Swagger -- will give it a go.
-
Swagger/Open api integration in laravel
I have been using laravel since one and a half years, mainly for apis building. I also use dotnet where the integration of swagger/open api is very easy. With some attributes, we can customize our documentation (http codes, possible return types,..). I am looking for a way to use it in laravel but I don't find one that satisfies me. I have tried [L5-Swagger](https://github.com/DarkaOnLine/L5-Swagger/) but I don't find it practical for several reasons : - Too much comments to write
-
Validate your PHP API tests against OpenAPI definitions – a Laravel example
The second one is L5 Swagger, a popular package bringing Swagger PHP and Swagger UI to Laravel. We actually don't need Swagger PHP here, as it uses Doctrine annotations to generate OpenAPI definitions and we're going to manually write our own instead. We do need Swagger UI, however, and the package conveniently adapts it to work with Laravel (the -W option is simply here to also update related dependencies, to avoid conflicts).
What are some alternatives?
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
swagger-php - A php swagger annotation and parsing library
Dokuwiki - The DokuWiki Open Source Wiki Engine
laravel-request-docs - Effortless API documentation tool for Laravel applications. Swagger alternative.
MkDocs - Project documentation with Markdown.
laravel-openapi - Generate OpenAPI specification for Laravel Applications
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams
openapi-psr7-validator - It validates PSR-7 messages (HTTP request/response) against OpenAPI specifications
bs
laravel-gmail - Laravel wrapper for the Gmail API
Apache Answer - A Q&A platform software for teams at any scales. Whether it's a community forum, help center, or knowledge management platform, you can always count on Apache Answer.
ui - Laravel UI utilities and presets.