I am using the io.springfox springfox-boot-starter v 3.0.0,
According to the documentation, this Spring Boot setup would disable the swagger endpoint for prod:
#Configuration
#Profile({"!prod && swagger"})
public class SwaggerConfig implements WebMvcConfigurer {
#Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.useDefaultResponseMessages(false)
.select()
.apis(RequestHandlerSelectors.any())
.build()
.apiInfo(apiInfo());
}
...
When on prod, the customisations of swagger defined here are indeed missing, but the Swagger UI endpoint is still there. How can I suppress the /swagger-ui/ endpoint altogether? Is there nothing like a springfox.swagger-ui.enabled=false property I can set somewhere in the spring boot application configuration?
You can disable using below property
springfox.documentation.enabled=false
Springfox Boot Starter API enable by default the 'auto-startup' configuration, means Swagger UI html page (ex. /swagger-ui/index.html) and Api-Docs (/v2/api-docs) JSON page containing a swagger with All API definitions.
For production environment is a good choise disable all the API documentation.
To disable all the swagger auto-configurations you can add on your application-prod.properties file the property below:
springfox.documentation.auto-startup=false
In this case with Your config on prod you have nothing about swagger.
If you want to remove the swagger-related resources completely, consider do it in the compile-time.
If you are using Apache Maven, it is easy to control dependencies and runtime configuration in a Maven profile, eg swagger.
When building for production, run the following command.
mvn package -Pprod
// for dev stage.
mvn clean spring-boot:run -Pdev,swagger
My example is a little old which used Maven to control different configuration in different stage.
I am using rest framework swagger for the first time in my Django application. When I run it locally from PyCharm it works just fine. My app runs on port 1337 and when I Try Out my restful API endpoint and click Execute, the curl command works and the URL includes the port.
The issue is when I run my Django app in a Docker. In this case, the URL in the curl command does not include the port. Do I have to add any swagger specific configuration to my docker compose file? I have not changed my Dockerfile nor my docker-compose file at all.
What do I need to do to get this to work properly?
It seems like you have set the url parameter for the get_schema_view(...)--(DRF Doc) function. The url is used to set the canonical base URL for the schema.
If you didn't set the value, DRF will use the "requested host" as the default URL.
Ref
url = self.url
if not url and request is not None:
url = request.build_absolute_uri()
SO, you can set the url to any value or you can exclude the parameter to get the default behavior.
from rest_framework.schemas import get_schema_view
urlpatterns = [
path('openapi', get_schema_view(
title="Your Project",
description="API for all things …",
version="1.0.0"
), name='openapi-schema'),
]
Please check the file urls.py which is the place you are setting URL for SWAGGER.
Don't set url in get_schema_view function.
Also, when you are running the app by using docker, the URL in the curl command does not include the port -> That's right!
I think that your file is using multiple settings for swagger by checking like this:
if getattr(settings, "SETTINGS_ENV", None) in ["local", "dev", "draft", "production"]:
I need to create swagger codegen client for java, javascript pointing to swagger yaml pusblished on https.
When tried below command got SSLHandshakeError.
"swagger-codegen generate -i https://localhost:443/api/swagger.yaml -l java -o java-api/."
Also when swagger codegen generates client will it have SSL Mutual TLS code for https swagger spec url?
Please help.
Please add -D io.swagger.parser.util.RemoteUrl.trustAll=true when generating the code.
Ref: https://github.com/swagger-api/swagger-codegen/wiki/FAQ#is-there-a-way-to-disable-certificate-verification
UPDATE: On May 2018, about 50 top contributors and template creators of Swagger Codegen decided to fork Swagger Codegen to maintain a community-driven version called OpenAPI Generator. Please refer to the Q&A for more information.
the above answer didn't work for me. if you are facing the same problem as I just use the bellow structure
( "swagger:generate": "SET JAVA_OPTS=-Dio.swagger.parser.util.RemoteUrl.trustAll=true -Dio.swagger.v3.parser.util.RemoteUrl.trustAll=true && openapi-generator generate -i https://xxxxxx/swagger/1.0/swagger.json -g typescript-angular -o ./src/code-gen"
)
that's how I solved it
I'm trying to add some unit tests to one of my projects.
So far I've installed and configured karma, and have installed jasmine. I've one test file in my test/ folder.
The karma server has started, the browser page is ready, but karma run fails as follows:
$ karma run karma-conf.js
[2014-06-14 15:19:11.046] [DEBUG] config - Loading config /foo/test/karma-conf.js
Waiting for previous execution...
Chrome 35.0.1916 (Linux) ERROR
You need to include some adapter that implements __karma__.start method!
This error message doesn't Google well.
Is this something obvious, or do I need to provide more information?
It does seem like this is a very general error, however in my case the problem was either that I didn't run karma start from the correct folder, or that I didn't restart it after changing the configuration.
I'll leave this question open and hopefully it can become a resource for others who experience this error message.
If you name your karma config file karma.conf.js, you can simply type karma start.
Otherwise specify the filename karma start karmafile.js
(I was in the right directory, but was not specifying a file name.)
You need to run your karma run or whatever function in the folder where karma-conf.js is in.
In my case I had to rename the file to karma.conf.js then do karma start
I had a problem with karma.conf.js file code format:
files: [
// Modules
,"client/bower_components/angular/angular.min.js"
,"client/bower_components/angular-mocks/angular-mocks.js"
// App
,"client/app/app.module.js"
// Test
// ,"test/**/*.spec.js"
],
The extra comma in files array have cause this error:
You need to include some adapter that implements __karma__.start method!
I was not running karma start command from the path where my karma.conf.js was. I switched to that folder and ran the same command. Thats all
I was facing this issue while running specs on the Angular.js codebase. I had to run npm install karma-jasmine -g to get this working.
If you typing "karma start", you must have a karma.conf.js file in the current folder. or just "karma start /path/karma.conf.js"
Try to create a new karmar.conf.js by "karma init /path/karma.conf.js"
In my case, I was applying by mistake the commonjs preprocessor to the karma-* modules and the adapter.js from karma-chrome and karma-firefox was broken this way.
Unfortunately, this is a very generic error.
I was getting the same error because the project was using Babel 6 and I had forgotten to add the babelrc file. Just sharing in case this could help.
In my case, the message was in fact very descriptive: I forgot to add an adapter, in my case Jasmine, into the config file. Thus:
module.exports = function(config) {
config.set({
browsers: ['Chrome'],
singleRun: true,
frameworks: ['jasmine'],
files: [
// ... files ...
],
// other configs
});
};
You need to configure your "my.conf.js" file, because it contains all the info to use to test your code.
All what you need to write is this:
The configuration file can be generated using karma init:
$ karma init my.conf.js
Which testing framework do you want to use?
Press tab to list possible options. Enter to move to the next question.
jasmine
Do you want to use Require.js?
This will add Require.js plugin.
Press tab to list possible options. Enter to move to the next question.
no
Do you want to capture a browser automatically?
Press tab to list possible options. Enter empty string to move to the next question.
Chrome
What is the location of your source and test files?
You can use glob patterns, eg. "js/*.js" or "test/**/*Spec.js".
Press Enter to move to the next question.
*.js
test/**/*.js
Should any of the files included by the previous patterns be excluded?
You can use glob patterns, eg. "**/*.swp".
Press Enter to move to the next question.
Do you want Karma to watch all the files and run the tests on change?
Press tab to list possible options.
yes
Config file generated at "/Users/vojta/Code/karma/my.conf.js".
You must specify the karma configuration file to karma.
karma start karma.config.js
It works for me
I must add that in my case karma was giving me the error because I had [square] brackets in the name of one of the parent folders.
Tt's complaining about the adapter which is probably jasmine or mocha.
Either the adapter is missing, either is not setup correctly, either it's an outdated or buggy version of the adapter.
In my case I had an old version of mocha 2.5.3 which was not compatible with karma 1+.
I updated the mocha dependency to the latest version available 3.2.0 and the problem solved.
While working on numerous vaguely described errors, I tried setting basePath: '../', After correcting other errors (like missing commas that were described as object content errors) the last change back to basePath: '', got karma to work. karma's error statements need a lot of work. It is not simple to get it going.
I had the same issue. My browser would open but on my terminal it threw the following error
30 08 2017 11:19:28.272:INFO [Chrome 58.0.3029 (Linux 0.0.0)]: Connected `enter code here`on socket 5sSs6E5KmpUVRp6LAAAB with id 93886631
Chrome 58.0.3029 (Linux 0.0.0) ERRORSome of your tests did a full page reload!
I checked my karma.conf.js file. In the framework array , i had included jasmine and requirejs. But i had only installed karma-jasmine.Removing requireJS and rerunning the karma start worked!
I've been struggling with this too. What I came up to is that this error occurs because one of the following reasons
No test adapter installed or defined (frameworks property in karma.conf.js
No karma configuration found (ie, no karma.conf.js in current dir or no config file specified in command)
My problem was that my config file was named karma.config.js instead of karma.conf.js.
If you've installed the test adapter but it still doesn't work, try running karma init and go through the guided config setup.
You will have to specify the directory of karma.config.js when you run start karma.
Try
karma start karma.config.js
I had a bad 'files' configuration in my karma.conf.js
files: ['**/*.js'],
this caught up all the files in node_modules/ including those of the karma-jasmine plugin, as it was seen as sourde files it wasn't loaded on startup. Changing to
files: [
'src/*.js',
'spec/*.js'
],
solved the problem in my case
FWIW - sourcing the file path of karma.conf.js worked for me locally, but not on my jenkins builder. I have zero clue why this is the case, but on jenkins it was throwing this error unless the karma.conf.js file was in the root directory where the karma command was given. I'm using rails and running the js specs through a rake task. Code is below which might be helpful for some.
https://gist.github.com/daino3/a39486ff8bfc1668e923
The issue in my case was that karma didn't pick up any files. Fixing it in karma.conf.js solved the issue.
Same issue happened to me, and it was due to an outdated module.
Running npm update solved it.
In my case, it was not karma-related at all! I run karma from gulp, with ES6/babel, and there was actually a code syntax error, flagged by a babel error above my karma:
ERROR [preprocessor.babel]: xxx.js: Unexpected token (19:83)
I fixed that in my src and karma was happy again.
In my case, the configuration file name was different. So, running the command specifying the conf file solved my issue.
>> karma start unit-tests.conf.js
No captured browser, open http://localhost:9876/
...
And for 'PhantomJS', opening the link specified(localhost:9876) in the browser executes the test cases.
Hope it helps. :)
EDIT 1: My Karma Config File
module.exports = function(config) {
config.set({
// base path that will be used to resolve all patterns (eg. files, exclude)
basePath: '',
// frameworks to use
// available frameworks: https://npmjs.org/browse/keyword/karma-adapter
frameworks: ['jasmine'],
// list of files / patterns to load in the browser
files: [
'./node_modules/angular/angular.js',
'./node_modules/angular-ui-router/release/angular-ui-router.js',
'./node_modules/angular-mocks/angular-mocks.js',
'./app/services/users/users.js',
'./app/app.js',
'./app/services/users/users.spec.js'
],
// list of files to exclude
exclude: [
],
// preprocess matching files before serving them to the browser
// available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
preprocessors: {
},
// test results reporter to use
// possible values: 'dots', 'progress'
// available reporters: https://npmjs.org/browse/keyword/karma-reporter
reporters: ['spec'],
// web server port
port: 9876,
// enable / disable colors in the output (reporters and logs)
colors: true,
// level of logging
// possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
logLevel: config.LOG_INFO,
// enable / disable watching file and executing tests whenever any file changes
autoWatch: true,
// start these browsers
// available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
browsers: ['Chrome'],
// Continuous Integration mode
// if true, Karma captures browsers, runs the tests and exits
singleRun: false,
// Concurrency level
// how many browser should be started simultaneous
concurrency: Infinity
})
}
I received this error because I required the same dependency twice!
Removing the duplicate file dependency removed the error for me. Circled in blue below.
Given this is the first result on google for this error message, I figured I'd mention my resolution here.
I was getting this error after converting an AngularJS 1.8 project to Typescript and trying to change over my Karma tests to use the typescript preprocessor.
I finally realized that adding import angular from 'angular' resolved the issue on Karma's side, but then angular turned up as undefined in webpack's build.
Eventually thanks to this answer on a question about that error message, I updated my import statements to import * as angular from 'angular', and finally it worked! (Ultimately I had to resolve every compilation error on every typescript file for complete resolution, which I had been somewhat ignoring since the webpack build worked.)
Hopefully this can help someone with this problem!
I had the same problem but above mentioned solutions didn't work for me. What I eventually found out is that my karmaWebpackConfig was using "babel-loader" as loader. I just removed that line and it worked for me.
When I hit http://localhost:3001/api-docs loads the swagger json docs.
{
swagger: "2.0",
info: {
version: "1.0.0",
title: "Auth-gateway services",
contact: {
name: "swagger docs",
url: "https://www.google.com"
}
},
host: "127.0.0.1:3001",
basePath: "/",
...
}
But how do I load UI like http://petstore.swagger.io/ for my APIs.
To view you api through swagger-ui, do one of the following.
Option 1: Using online swagger-ui
Go to this.
On the dialog-box on the top of the page, provide the url for swagger-json. In your case, insert http://localhost:3001/api-docs instead of http://petstore.swagger.io/v2/swagger.json (which can be seen in default) and click Explore.
Now you can see swagger-ui generated for your api.
Option 2: Setting up swagger-ui project locally
You have to set up swagger-ui. You can clone the project set up that with the below instructions provided.
Windows Users: Please install Python before follow below guidelines
for node-gyp rebuild to run.
1. npm install
2. npm run build
3. You should see the distribution under the dist folder. Open ./dist/index.html to launch Swagger UI in a browser
Development
Use npm run serve to make a new build, watch for changes, and serve the result at http://localhost:8080/.
Now you should be able to see something exactly like online swagger-ui.
Do the same as option 1 to provide swagger-json url and see swagger-ui generated.