swagger-api/swagger-codegen

[Apex] Use NamedCredentials/Callouts instead of remoteSite

Open

#5,679 opened on May 21, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: ApexEnhancement: Generalhelp wanted

Description

Description

The initial implementation for Apex supports only remote site settings. That leads to the issue that the developer has to hardcode authentication credentials into the Apex classes.

The best approach is to use Named Credentials in combination with callouts. With that an administration can define URL/Credentials etc. via UI in Salesforce and nothing needs to be hardcoded in the Apex classes.

Swagger-codegen version

master

Contributor guide

Tech stack
None
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Apex knowledgeNamedCredentials conceptSalesforce calloutsSwagger codegen codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
The existing Apex template in swagger codegen uses RemoteSiteSettings. Investigate the Apex code generation template (likely in modules/swagger codegen/src/main/resources/apex/) and understand how remoteSite is configured. Then, research Salesforce Named Credentials and callouts to replace remoteSite. Check the swagger codegen issue #5679 for any discussion. The solution should involve modifying the template to allow administrators to define URL/credentials via UI instead of hardcoding.