Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: mpociot/laravel-apidoc-generator
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 2.1.0
Choose a base ref
...
head repository: mpociot/laravel-apidoc-generator
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: master
Choose a head ref
Loading
Showing with 9,585 additions and 3,446 deletions.
  1. +1 −0 .gitattributes
  2. +10 −1 .gitignore
  3. +1 −5 .styleci.yml
  4. +33 −12 .travis.yml
  5. +325 −17 CHANGELOG.md
  6. +4 −10 CONTRIBUTING.md
  7. +20 −223 README.md
  8. BIN body_params_1.png
  9. BIN body_params_2.png
  10. +34 −14 composer.json
  11. +293 −0 config/apidoc.php
  12. +71 −0 dingo.composer.json
  13. +4 −0 docs/_index.md
  14. +4 −0 docs/extending/_index.md
  15. +178 −0 docs/extending/plugins.md
  16. +4 −0 docs/getting-started/_index.md
  17. +252 −0 docs/getting-started/configuration.md
  18. +355 −0 docs/getting-started/documenting-your-api.md
  19. +76 −0 docs/getting-started/generating-documentation.md
  20. +35 −0 docs/getting-started/installation.md
  21. +40 −0 docs/getting-started/migrating.md
  22. +4 −0 docs/under-the-hood/_index.md
  23. +16 −0 docs/under-the-hood/architecture.md
  24. +14 −0 docs/under-the-hood/how-it-works.md
  25. +14 −0 phpstan.neon
  26. +4 −5 phpunit.xml
  27. +19 −0 resources/views/documentarian.blade.php
  28. +13 −0 resources/views/partials/example-requests/bash.blade.php
  29. +41 −0 resources/views/partials/example-requests/javascript.blade.php
  30. +24 −0 resources/views/partials/example-requests/php.blade.php
  31. +23 −0 resources/views/partials/example-requests/python.blade.php
  32. +3 −2 {src → }/resources/views/partials/frontmatter.blade.php
  33. 0 {src → }/resources/views/partials/info.blade.php
  34. +65 −0 resources/views/partials/route.blade.php
  35. +13 −0 routes/laravel.php
  36. +36 −0 src/ApiDoc.php
  37. +59 −0 src/ApiDocGeneratorServiceProvider.php
  38. +206 −0 src/Commands/GenerateDocumentation.php
  39. +29 −0 src/Commands/RebuildDocumentation.php
  40. +244 −0 src/Extracting/Generator.php
  41. +131 −0 src/Extracting/ParamHelpers.php
  42. +71 −0 src/Extracting/RouteDocBlocker.php
  43. +94 −0 src/Extracting/Strategies/BodyParameters/GetFromBodyParamTag.php
  44. +101 −0 src/Extracting/Strategies/Metadata/GetFromDocBlocks.php
  45. +96 −0 src/Extracting/Strategies/QueryParameters/GetFromQueryParamTag.php
  46. +16 −0 src/Extracting/Strategies/RequestHeaders/GetFromRouteRules.php
  47. +376 −0 src/Extracting/Strategies/Responses/ResponseCalls.php
  48. +194 −0 src/Extracting/Strategies/Responses/UseApiResourceTags.php
  49. +73 −0 src/Extracting/Strategies/Responses/UseResponseFileTag.php
  50. +66 −0 src/Extracting/Strategies/Responses/UseResponseTag.php
  51. +201 −0 src/Extracting/Strategies/Responses/UseTransformerTags.php
  52. +40 −0 src/Extracting/Strategies/Strategy.php
  53. +96 −0 src/Extracting/Strategies/UrlParameters/GetFromUrlParamTag.php
  54. +25 −0 src/Http/Controller.php
  55. +23 −0 src/Matching/LumenRouteAdapter.php
  56. +89 −0 src/Matching/RouteMatcher.php
  57. +78 −0 src/Matching/RouteMatcher/Match.php
  58. +18 −0 src/Matching/RouteMatcherInterface.php
  59. +0 −58 src/Mpociot/ApiDoc/ApiDocGeneratorServiceProvider.php
  60. +0 −371 src/Mpociot/ApiDoc/Commands/GenerateDocumentation.php
  61. +0 −58 src/Mpociot/ApiDoc/Commands/UpdateDocumentation.php
  62. +0 −588 src/Mpociot/ApiDoc/Generators/AbstractGenerator.php
  63. +0 −94 src/Mpociot/ApiDoc/Generators/DingoGenerator.php
  64. +0 −295 src/Mpociot/ApiDoc/Generators/LaravelGenerator.php
  65. +0 −86 src/Mpociot/ApiDoc/Parsers/RuleDescriptionParser.php
  66. +0 −67 src/Mpociot/ApiDoc/Postman/CollectionWriter.php
  67. +18 −0 src/Tools/DocumentationConfig.php
  68. +8 −0 src/Tools/Flags.php
  69. +174 −0 src/Tools/Utils.php
  70. +198 −0 src/Writing/PostmanCollectionWriter.php
  71. +309 −0 src/Writing/Writer.php
  72. +0 −34 src/resources/lang/en/rules.php
  73. +0 −19 src/resources/views/documentarian.blade.php
  74. +0 −68 src/resources/views/partials/route.blade.php
  75. +0 −424 tests/ApiDocGeneratorTest.php
  76. +0 −354 tests/DingoGeneratorTest.php
  77. +0 −30 tests/Fixtures/CustomValidatorRequest.php
  78. +0 −18 tests/Fixtures/DependencyInjection.php
  79. +0 −28 tests/Fixtures/DingoTestController.php
  80. +0 −56 tests/Fixtures/DingoTestRequest.php
  81. +0 −15 tests/Fixtures/DynamicRequest.php
  82. +282 −22 tests/Fixtures/TestController.php
  83. +43 −0 tests/Fixtures/TestGroupController.php
  84. +9 −0 tests/Fixtures/TestNonCommentedRequest.php
  85. +20 −0 tests/Fixtures/TestPartialResourceController.php
  86. +14 −47 tests/Fixtures/TestRequest.php
  87. +18 −11 tests/Fixtures/TestResourceController.php
  88. +9 −0 tests/Fixtures/TestUser.php
  89. +24 −0 tests/Fixtures/TestUserApiResource.php
  90. +25 −0 tests/Fixtures/TestUserApiResourceCollection.php
  91. +3 −0 tests/Fixtures/append.md
  92. +399 −1 tests/Fixtures/collection.json
  93. +73 −0 tests/Fixtures/collection_custom_url.json
  94. +45 −0 tests/Fixtures/collection_with_body_parameters.json
  95. +49 −0 tests/Fixtures/collection_with_custom_headers.json
  96. +76 −0 tests/Fixtures/collection_with_query_parameters.json
  97. +73 −0 tests/Fixtures/collection_with_secure_url.json
  98. +493 −40 tests/Fixtures/index.md
  99. +114 −0 tests/Fixtures/partial_resource_index.md
  100. +3 −0 tests/Fixtures/prepend.md
  101. +164 −133 tests/Fixtures/resource_index.md
  102. +1 −0 tests/Fixtures/response_error_test.json
  103. +1 −0 tests/Fixtures/response_test.json
  104. +337 −122 tests/GenerateDocumentationTest.php
  105. +0 −118 tests/RuleDescriptionParserTest.php
  106. +53 −0 tests/TestHelpers.php
  107. +52 −0 tests/Unit/DingoGeneratorTest.php
  108. +238 −0 tests/Unit/GeneratorPluginSystemTestCase.php
  109. +1,024 −0 tests/Unit/GeneratorTestCase.php
  110. +36 −0 tests/Unit/LaravelGeneratorTest.php
  111. +313 −0 tests/Unit/PostmanCollectionWriterTest.php
  112. +310 −0 tests/Unit/RouteMatcherDingoTest.php
  113. +222 −0 tests/Unit/RouteMatcherTest.php
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -7,3 +7,4 @@
/.travis.yml export-ignore
/phpunit.xml export-ignore
/README.md export-ignore
/body-params.png export-ignore
11 changes: 10 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
.DS_Store
composer.lock
*.composer.lock
.php_cs.cache
/vendor/
/public
public/
resources/docs/
resources/views/apidoc/
tests/public/
.idea/
coverage.xml
results.xml
docs/_build
docs/make.bat
tests/public/docs/
tests/resources/**
.phpunit.result.cache
6 changes: 1 addition & 5 deletions .styleci.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,2 @@
preset: laravel
preset: psr12

enabled:
- phpdoc_order
- phpdoc_separation
- unalign_double_arrow
45 changes: 33 additions & 12 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,40 @@
dist: bionic
language: php

php:
- 5.6
- 7.0
- 7.1
env:
global:
- SETUP=stable

before_script:
- travis_retry composer self-update
- travis_retry composer install --prefer-dist --no-interaction
matrix:
fast_finish: true
include:
- php: 7.4
env: COMPOSER=dingo.composer.json
name: "With Dingo router"
- php: 7.4
env: SETUP=lint
name: "Lint code"
- php: 7.2
- php: 7.2
env: SETUP=lowest
- php: 7.3
- php: 7.3
env: SETUP=lowest
- php: 7.4
- php: 7.4
env: SETUP=lowest

script:
- composer test-ci
cache:
directories:
- $HOME/.composer/cache

before_install:
- pip install --user codecov
- travis_retry composer self-update

after_success:
- codecov
install:
- if [[ $SETUP = 'stable' ]]; then travis_retry composer update --prefer-dist --no-interaction --prefer-stable --no-suggest; fi
- if [[ $SETUP = 'lowest' ]]; then travis_retry composer update --prefer-dist --no-interaction --prefer-lowest --prefer-stable --no-suggest; fi
- if [[ $SETUP = 'lint' ]]; then travis_retry composer update --prefer-dist --no-interaction --prefer-stable --no-suggest; travis_retry composer lint; fi

script:
- if [[ $SETUP = 'lint' ]]; then exit 0; fi; composer test-ci;
Loading